Contributions are welcome - we want to keep it as easy as possible to contribute
changes that get things working in your environment. There are a few guidelines
that we need contributors to follow so that we can have a chance of keeping on
top of things.
- Make sure your have a GitHub account
- Check for existing issues in the OpenXC
Repository corresponding to your issue.
- If an issue does not already exist, create a new issue.
- Clearly describe the issue including steps to reproduce, if the issue is a
- Be sure to include any information about platforms or versions affected by
- If you haven’t already, create a new issue on GitHub for your bug fix or new
- Fork the repository in which you would like to make changes.
- Make a local clone of your newly forked repository.
- Create a new branch related to the issue on which you are working.
- Make changes using the IDE of your choice.
- Commit your changes frequently, in logical units.
- Check for unnecessary whitespace with
git diff --check before
- Make sure your commit messages are in the proper
- Make sure you have tested your changes and added any necessary tests.
- How to add changes to your local repository: GitRef -
- How to commit changes to your local repository: GitRef -
- Push the changes in your branch to your GitHub fork.
- Sign the Contributor License
- Submit a pull request to the repository in the openxc organization.
- Note: small changes such as spelling corrections and simple bug fixes can
be pulled from the master branch. Any larger changes should be pulled from
the “next” branch in each repository. Please initiate your pull requests to the
- How to request a pull: GitHub - Initiating the Pull