Skip to content

Latest commit

 

History

History
65 lines (39 loc) · 2.77 KB

CONTRIBUTING.md

File metadata and controls

65 lines (39 loc) · 2.77 KB
Raw

Contributing to functional-annotation-genomic-proteomic-data

Thank you for your interest in contributing to functional-annotation-genomic-proteomic-data! We welcome contributions of all kinds, including bug fixes, feature requests, documentation improvements, and code contributions. This guide will help you get started.

How to Contribute

  1. Fork the repository: Start by forking the repository to your own GitHub account.

  2. Clone your fork: Clone your forked repository to your local development environment.

    git clone https://github.com/hackbio-ca/functional-annotation-genomic-proteomic-data.git

  3. Create a new branch: Create a new branch for your changes. Use a descriptive branch name that indicates the work you are doing.

    git checkout -b feature/add-new-feature

  4. Make your changes: Implement your changes, whether it's adding a new feature, fixing a bug, or updating documentation.

  5. Commit your changes: Use meaningful commit messages to describe what you've done. If your commit resolves an issue, reference the issue number.

    git commit -m "Add feature to handle XYZ (#123)"

  6. Push your branch: Push your branch to your fork on GitHub.

    git push origin feature/add-new-feature

  7. Open a pull request: Navigate to the original repository and open a pull request from your fork. Provide a detailed description of your changes, including any relevant issue numbers.

Code Style Guidelines

Please follow these guidelines to ensure consistency across the codebase:

  • Use meaningful variable and function names.
  • Add comments and docstrings to explain complex logic or functions.
  • Write tests to cover your changes when applicable.

Reporting Issues

If you encounter a bug, have a question, or want to suggest a new feature, please open an issue on GitHub. Provide as much detail as possible, including:

  • Steps to reproduce the issue.
  • The expected behavior and the observed behavior.
  • Relevant error messages or logs.

Documentation

If your contribution requires changes to the documentation, please update the relevant documentation files and include your changes in the pull request.

Code of Conduct

We strive to maintain a positive and inclusive community. Please adhere to our Code of Conduct when participating in discussions or contributing to the project.

License

By contributing to functional-annotation-genomic-proteomic-data, you agree that your contributions will be licensed under the MIT License.

We appreciate your contributions and look forward to working together to improve functional-annotation-genomic-proteomic-data!