👍🎉 First off, thanks for taking the time to contribute! 🎉👍
We welcome contributions, in the following ways:
- Issues
- Enhancement requests (also tracked as GitHub issues.)
- Pull requests
If you have a question, want to report a bug, or have an enhancement suggestions then please submit an issue.
We plan to have the following features in the future.
- Sawhorse projection
- Projections/conformations such as Chair/Boat/Twisted boat conformations
- Haworth projections
If you are interested in building any of these join this discord channel
To contribute with code to the project make a pull request with the below process.
- Fork this repository.
- Create a branch:
git checkout -b <branch_name>. - Format your code with the black package.
- Make your changes and commit them.
Use the conventional-commits format. A good and easy way to do this is to install commitizen tool.
For the interactive version look here.
For the non-interactive CLI version look here. - Update the README.md with details of changes.
- Increase the version number and generate changelog using commitizen :
cz bump --changelog. The versioning scheme we use is SemVer. - Push to the remote branch:
git push - Create the pull request.