Thank you for considering contributing to plasmidcanvas! Contributions are massively welcome and encouraged.
If you encounter a bug or unexpected behavior, please search the existing issues to see if it has already been reported. If not, please open a new issue and provide a clear description of the problem along with steps to reproduce it.
If you have a feature request or an enhancement idea, please search the existing issues to see if it has already been requested. If not, please open a new issue and describe the feature or enhancement you'd like to see.
- Fork the repository on GitHub.
- Clone your forked repository to your local machine:
git clone https://github.com/th0mr/plasmidcanvas.git- Navigate to the cloned repo
- Install dependencies with "poetry install"
- Create a new branch for your changes
git checkout -b feature-name- Make and test your fix / improvement and commit them to your branch. Please adhere to the code style guidelines listed later in this document. Tests can be found in /tests and exist as a convenience method to make and inspect a few plasmids that are used in the usage guide, test images are saved to /tests/test_output to be manually inspected.
git commit -am "Add new feature or fix bug"- Push your commit to your branch
git push origin feature-name- Open a pull request back to "main" with an explaination of your changes and maybe some images.
- The pull request will be reviewed and likely accepted!
Please follow the guidelines below when documenting your contributions:
Adhere to PEP 8 guidelines where possible. Use NumPy-style docstrings for all public functions and methods. These are consumed by AutoAPI to produce our automated documentation. Ensure your code is well-commented and self-explanatory where possible.
By contributing to plasmidcanvas, you agree that your contributions will be licensed under the MIT License.
Thank you for your interest in contributing to plasmidcanvas! If you have any questions or need further assistance, please feel free to reach out.