Contributions are always welcome!
Please use the following guidelines when contributing to wolfram-alpha-rs
:
- Fork
wolfram-alpha-rs
- Clone your fork (
git clone https://github.com/$YOUR_USERNAME/wolfram-alpha-rs && cd wolfram-alpha-rs
) - Create a new branch (
git checkout -b new-branch
) - Make your changes
- Commit your changes (
git commit -am "your message"
)
- This project uses the
conventional changelog format, so that we can
easily update the
CHANGELOG.md
using clog. - In addition to the conventions defined above, we also use
imp
,wip
, andexamples
. - Format your commit subject line using the following format:
TYPE(COMPONENT): MESSAGE
whereTYPE
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 begit rebase
'ed away)chore
- Catch all or things that have to do with the build system, etc.examples
- Changes to an existing example, or a new example
- The
COMPONENT
is optional, and may be a single file, directory, or logical component. Can be omitted if commit applies globally
- Run the tests (
cargo test
) git rebase
into concise commits and remove--fixup
s (git rebase -i HEAD~NUM
whereNUM
is number of commits back)- Push your changes back to your fork (
git push origin $your-branch
) - Create a pull request! (You can also create the pull request first, and we'll merge when ready. This a good way to discuss proposed changes.)