Contributing to rbamlib

Thank you for your interest in contributing to rbamlib! There are several ways you can contribute to this project.

  • Reporting Issues: If you find a bug or have a suggestion for improving rbamlib, please use the Issues section on GitHub to let us know. Providing detailed information will help us understand and address the issue more effectively.

  • Developing New Features: If you’re interested in adding new functionality to rbamlib, you’re encouraged to fork the repository, develop your feature, and submit a pull request. Your proposed features can range from new capabilities within the library to enhancements of existing functions. We welcome all ideas and appreciate your effort to expand rbamlib’s features.

Report bugs using Github’s issues

We use GitHub issues to track public bugs. Report a bug by opening a new issue!

Great Bug Reports should have:

  • A quick summary and/or background

  • Steps to reproduce (give sample code if you can).

  • What you expected would happen and what actually happens

How to contribute in development

  1. Fork the Repository: Begin by forking the rbamlib repository to your GitHub account. This creates your own copy of the project where you can make changes.

  2. Clone Your Fork: Clone your forked repository to your local machine to start working on the changes. Use the command git clone https://github.com/your-username/rbamlib.git.

  3. Create a New Branch: Create a new branch for your feature or bug fix using git checkout -b feature-branch or git checkout -b fix-branch, respectively.

  4. Implement Your Changes: Make your changes, ensuring they meet the project’s standards and guidelines. Remember to keep your changes focused and related to the issue you’re addressing or the feature you’re adding.

  5. Push Changes to Your Fork: After making your changes, commit them and push the branch to your fork on GitHub using git push origin feature-branch or git push origin fix-branch.

  6. Submit a Pull Request: Finally, go to the original rbamlib repository on GitHub and create a new pull request. Provide a detailed description of your changes and how they improve the project.

PyHC Coding Standards

Please ensure all code submissions and contributions adhere to the PyHC Coding Standards and follow best practices for open scientific research.

Thank you for your contributions to making this project even better!