Skip to content

Latest commit

 

History

History
64 lines (40 loc) · 1.71 KB

CONTRIBUTING.rst

File metadata and controls

64 lines (40 loc) · 1.71 KB

Contributing

You can contribute in many ways:

Report Bugs

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.

Submit Feedback

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.

Fix Bugs Or Implement Features

To contribute code to fix bugs or implement new features in PEGS:

  1. Fork the pegs repository on GitHub.

    1. Clone your fork locally:

    $ git clone [email protected]:your_name_here/pegs.git

  1. Install your local copy into a Python virtualenv.

  2. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature
    

    Now you can make your changes locally.

  3. 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
    
  1. Submit a pull request against the devel branch through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. Pull requests should be made against the devel branch.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring.