Skip to content

Latest commit

 

History

History
55 lines (34 loc) · 2.07 KB

CONTRIBUTING.md

File metadata and controls

55 lines (34 loc) · 2.07 KB

Contributing to Bio-image Analysis Quality Control

Thank you for considering contributing to this project! We welcome contributions from the community and are grateful for your support.

How to Contribute

Reporting Bugs

If you find a bug, please report it by opening an issue on our GitHub Issues page. Include as much detail as possible to help us understand and reproduce the issue.

Suggesting Features

We welcome suggestions for new features. Please open an issue on our GitHub Issues page and describe the feature you would like to see, along with any relevant use cases.

Submitting Pull Requests

  1. Fork the Repository: Click the "Fork" button on the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone the Forked Repository: Clone your forked repository to your local machine.

    git clone https://github.com/rkarmaka/BIA-QC.git

  3. Create a Branch: Create a new branch for your feature or bug fix.

    git checkout -b feature-or-bugfix-name

  4. Make Changes: Make your changes to the codebase.

  5. Commit Changes: Commit your changes with a descriptive commit message.

    git commit -m "Description of the changes"

  6. Push Changes: Push your changes to your forked repository.

    git push origin feature-or-bugfix-name

  7. Open a Pull Request: Go to the original repository and open a pull request. Provide a clear description of the changes and any relevant information.

Code Style

Please follow the existing code style and conventions used in the project. This helps maintain consistency and readability.

Testing

Ensure that your changes do not break existing tests and, if applicable, add new tests for your changes. Run the tests locally before submitting your pull request.

Documentation

If your changes affect the documentation, please update the relevant documentation files accordingly.

Thank you for your contributions!