All contributions to the project are welcome! Before you start working with the project, we ask that you please read this document and follow the guidelines within.
-
Take a look at existing issues.
- If you need to create a new issue:
- Make sure to use a clear and descriptive title.
- Include as much information as possible: Steps to reproduce the issue, error message, version, operating system, etc.
- Include the Operating System you are using.
- If you need to create a new issue:
- You have cloned the repository.
- Rust is installed.
To run the project, run the following command:
cargo runTo run the tests, run the following command:
cargo test- Use a clear and descriptive title for the pull request.
- Describe the purpose of the pull request in the description.
- Reference any related issues and prs in the description.
- Include any necessary tests for the changes you have made.
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>[(scope)]: <subject>
<BLANK LINE>
[body]
<BLANK LINE>
[footer]
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
If the commit reverts a previous commit, it should begin with revert: , followed by the header of the reverted commit. In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit being reverted.
Must be one of the following:
- build: Changes that affect the build system or external dependencies (example scopes: cargo, npm)
- ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
- docs: Documentation only changes
- feat: A new feature
- fix: A bug fix
- perf: A code change that improves performance
- refactor: A code change that neither fixes a bug nor adds a feature
- style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
- test: Adding missing tests or correcting existing tests
The scope could be anything specifying place of the commit change. For example parser, lexer, compiler, runtime, etc...
The subject contains succinct description of the change:
- use the imperative, present tense: "change" not "changed" nor "changes"
- don't capitalize first letter
- no dot (.) at the end
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to reference GitHub issues that this commit Closes.
A detailed explanation can be found in this document.