optsp loves to welcome your contributions. There are several ways to help out:
- Create an issue on GitHub, if you have found a bug
- Write test cases for open bug issues
- Write patches for open bug/feature issues, preferably with test cases included
- Contribute to the documentation
- There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
- 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 topic branch from where you want to base your work.
- This is usually the master branch.
- Only target release branches if you are certain your fix must be on that branch.
- To quickly create a topic branch based on master; git branch master/my_contribution master then checkout the new branch with git checkout master/my_contribution. Better avoid working directly on the master branch, to avoid conflicts if you pull in updates from origin.
- Make commits of logical units.
- Check for unnecessary whitespace with git diff --check before committing.
- Use descriptive commit messages and reference the #issue number.
- Core test cases should continue to pass.
- Bugfix branches will be based on master.
- New features that are backwards compatible will be based on the develop branch.
- Push your changes to a topic branch in your fork of the repository.
- Submit a pull request to the repository in the optsp organization, with the correct target branch.
If you've found a security related issue in optsp, please don't open an issue in github. Instead contact us at optsp@xxiong.me.