Contributions are always welcome! Please use the following guidelines when contributing to clap
clap
git clone https://github.com/$YOUR_USERNAME/clap-rs && cd clap-rs
)git checkout -b new-branch
)git commit -am "your message"
)imp
, wip
, examples
.TYPE(COMPONENT): MESSAGE
where TYPE
is one of the following:feat
- A new featureimp
- An improvement to an existing featureperf
- A performance improvementdocs
- Changes to documentation onlytests
- Changes to the testing framework or tests onlyfix
- A bug fixrefactor
- Code functionality doesn't change, but underlying structure maystyle
- Stylistic changes only, no functionality changeswip
- A work in progress commit (Should typically be git rebase
'ed away)chore
- Catch all or things that have to do with the build system, etcexamples
- Changes to existing example, or a new exampleCOMPONENT
is optional, and may be a single file, directory, or logical component. Can be omitted if commit applies globallycargo test --features yaml && make -C clap-tests test
)git rebase
into concise commits and remove --fixup
s (git rebase -i HEAD~NUM
where NUM
is number of commits back)git push origin $your-branch
)Another really great way to help is if you find an interesting, or helpful way in which to use clap
. You can either add it to the examples/ directory, or file an issue and tell me. I'm all about giving credit where credit is due :)
There are a few goals of clap
that I'd like to maintain throughout contributions.
clap
should be low since the main program is the star of the showpanic!
on developer error, exit gracefully on end-user error