vuls
Agenda
- Who am I
- Happy stories Vuls aims for
- Contribution by coding
- Contribution by documentation
- Conclusion
Who am I
Thank you for stocking my article
The Origin of Vuls
India is the origin of Vuls.
kotakanbe returned from india, and he decided to contribute the World Peace.
kotakanbe's Hope
He wish everyone will be happy with Vuls.
Vuls users will and Vuls contributor as well.
Vuls Welcome Pull Requests
Vuls will be glad to accept new features and also misspells of README.
You can be HAPPY by the coding contribution
By coding contributions, you can ...
- customize vuls as you like.
- receive coding reviews from kotakanbe.
- be a famous programmer as a big OSS contributor.
How to develop Vuls
I recommend you develop vuls under $GOPATH/src/github.com/future-architect/vuls.
when running your vuls code, you execute go run main.go or go build && ./vuls
see http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html
After developing something you want, you push the vuls code into your fork repository, and make a pull request.
Important Points
There are 3 points we should confirm before making pull request.
-
Codeing Style.
- kotakanbe, of course, has the own coding style. you should check it at codes. If you are unable to make a decision, you can casually ask kotakanbe at the vuls slack team.
-
Rebase.
- The vuls owner(kotakanbe) will be glad if you fix conflict before sending the pull request.
-
Combining multiple commits into one.
- a pull request that is consisted of one commit, is simple and easy to read.
- If you want to separate your commits, it's better to separate your pull request.
Finally, Im looking forward to your pull requests.
How to make the Vuls develop environment
I made vuls cloudformation and vuls cookbook.
Unfortunately, this is under development.
You are not a golang programmer? Don't worry about it.
Vuls documentation project is coming...
You can be HAPPY by the document contribution too
We will start the Vuls documentation project.（Perhaps, next week）
If you can not contribute Vuls by coding, you can do it by documentations.
Let's become HAPPY with Vuls.
