You can contribute in many ways:
Report bugs at https://github.com/fls-bioinformatics-core/pegs/issues.
If you are reporting a bug, please include:
- Your operating system name and version, and the version of PEGS.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
The best way to send feedback is to file an issue at https://github.com/fls-bioinformatics-core/pegs/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
To contribute code to fix bugs or implement new features in PEGS:
Fork the
pegs
repository on GitHub.- Clone your fork locally:
$ git clone [email protected]:your_name_here/pegs.git
Install your local copy into a Python virtualenv.
Create a branch for local development:
$ git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally.
Commit your changes and push your branch to GitHub:
$ git add . $ git commit -m "Your detailed description of your changes." $ git push origin name-of-your-bugfix-or-feature
- Submit a pull request against the
devel
branch through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
- Pull requests should be made against the
devel
branch. - If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.