How to contribute¶
This section is under construction. Please contribute!
Contributions to this project, whether new features or bug fixes, are deeply appreciated and benefit the whole user community.
The following guidelines help ensure the smooth running of the project, and keep a consistent standard across the codebase. They are guidelines only - should you feel a need to deviate from them it is probably for a good reason - but please adhere to them as closely as possible.
If you would like to contribute code or documentation to the project, we welcome pull requests.
New features and bugs should always be added in the issue tracker. It might be a good idea to discuss in the forum first if you are not sure if it is a bug or a feature we want to include in the library.
See the License page. Your contributions must be your own work and licensed under the same terms as Helix Toolkit.
The repository contains two branches:
master- the release branch (stable channel)
develop- the main branch with the latest development changes (pre-release channel)
See A successful git branching model for more information about the branching model in use.
- Search the issue tracker to see if the bug or new feature is already there.
- If not, create a new issue
- Wait for the issue to be tagged
- Create a fork, branch, do the changes, commit, rebase, push
- Create a pull request
The changes will be reviewed and merged into the origin if everything is OK.
Working with Git¶
- Log in to GitHub and open the origin repository. Click the “Fork” button to create your own fork of the repository.
- Create a clone on your local system:
git clone https://github.com/yourusername/helix-toolkit.git
- Create a branch for the bugfix/feature you want to work on:
git branch bugfix-some-error
- Checkout the branch:
git checkout bugfix-some-error
- Commit your changes:
git commit -m <msg>
- Rebase interactively (“squash”) to the latest commit of the origin
- Open the GitHub page for your fork and create a “Pull Request”
- Include the issue number in the pull request comment (not in the title where it will not be linked!)
Please follow the style of the other messages in the commit history. Explain the intentions for the change and include the issue number.
Requirements for pull requests¶
- The pull request should be based on the latest commit on the
developbranch of the origin repository
- Include examples or unit tests for the change / new feature
- Update the CHANGELOG.md file
- Make sure the code builds
- Make sure all unit tests are passing
- Follow the Coding style, make sure there are no StyleCop issues
- squash each logical change to a single commit
- create a branch/pull request for each issue, do not combine multiple issues
- define full name and e-mail address in the change list user information
- update the AUTHORS and CONTRIBUTORS files if you are not already listed there
- include the issue number in the commit message, e.g. “#9945”
- follow the style of the existing commit messages