Contributing

Whether you find a typo in the documentation, find a bug, or want to develop functionality that you think will make bed more robust, you are welcome to contribute!

Opening issues

If you find a bug or would like to contribute a new feature, please open an issue.

Contribution workflow

The following is the recommended workflow for contributing to bed:

  1. Fork the bed repository and then clone it locally:

git clone https://github.com/<your-user-name>/bed

  1. Create a branch for your changes

git checkout -b bug/some-bug

# or

git checkout -b feature/some-feature

  1. Add your recommended changes and ensure all tests pass, then commit your changes

git commit -m '<my short message>'

  1. Push your changes to the remote

git push origin <my-branch-name>

  1. Submit a pull request with the following information:

  • Purpose: The reason for your pull request in short

  • Summary: A description of the environment you are using (OS, Python version, etc.), logic, any caveats, and a summary of changes that were made.