Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.16 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.16 KB
Raw

Contributing to pycellga

Thank you for considering contributing to pycellga! We welcome contributions from the community and are excited to collaborate with you.

How to Contribute

Reporting Bugs

If you find a bug, please report it by creating an issue in the issue tracker. Include detailed information about the bug, including steps to reproduce it, the expected behavior, and what actually happens.

Suggesting Enhancements

If you have an idea for an enhancement or a new feature, please open an issue in the issue tracker to discuss it. Provide as much detail as possible, including the problem the enhancement would solve and any suggested solutions.

Contributing Code

  1. Fork the Repository: Fork the repository on GitHub and clone it to your local machine.
  2. Create a Branch: Create a new branch for your work. 
    git checkout -b feature-branch
  3. Make Changes: Make your changes to the codebase. Ensure your code adheres to the project's coding standards.
  4. Commit Changes: Commit your changes with a descriptive commit message. 
    git commit -m "Description of the feature or fix"
  5. Push Changes: Push your changes to your forked repository. 
    git push origin feature-branch
  6. Create a Pull Request: Open a pull request to merge your changes into the main repository. Provide a clear and detailed description of your changes.

Code Style

Please ensure your code follows the project's coding standards. Use PEP 8 as a guideline for Python code.

Testing

Ensure that your code changes do not break existing tests and write new tests for new functionality. Run all tests to verify.

Documentation

Update documentation as necessary to reflect your changes. This includes updating the README.md file and any relevant docstrings in the code.

Code of Conduct

Please read and adhere to the Code of Conduct for contributing to this project.

Thank You!

Thank you for your contributions! We appreciate your effort and look forward to collaborating with you.