Fivium welcomes your contributions. There are several ways to help out:
- Create an issue on GitHub, if you have found a bug (be sure to search the existing list of issues first).
- Write test cases for open bug issues.
- Write patches for open bug/feature issues, preferably with test cases included.
There are a few guidelines that we need contributors to follow.
- Make sure you have a GitHub account.
- Submit an issue, assuming one does not already exist.
- Clearly describe the issue including steps to reproduce when it is a bug.
- Make sure you fill in the earliest version that you know has the issue.
- Fork the repository on GitHub.
- Create a branch from the master branch in your fork.
- Your new branch should be logically named in relation to the changes you are going to make.
- Make commits of logical units:
- code should compile / run / work before and after each commit
- interdependent changes should be committed together
- Your work should fit in with prevailing code formatting, for example:
- 2 space indents (not tabs)
- no unnecessary whitespace
- consistent naming conventions
- consistent syntactic style
- Write good commit messages:
- Include enough detail so the change can be understood without looking at the code differences.
- Explain why a change was made, not just what was changed.
- Follow the 50/72 rule.
- Push the changes on your local branch to GitHub. This will create or refresh the branch on your fork of our code.
- Submit a pull request to our original repository (GitHub should prompt you to do this).
- In your pull request comment, please reference any issues that the request resolves.
- Fivium is under no obligation to merge your change, please don't be upset if we don't want to for some reason.
- If we like your change, we will consider any pull requests seriously and review the code changes.
- We may ask you to update formatting or make other alterations as part of the pull request.
- If in doubt, please ask us!