First and foremost, thank you for considering contributing to ViT-Planetarium. It's people like you that make ViT-Planetarium such a great tool.
- Fork the repository on GitHub.
- Clone your forked repository to your local machine.
- Create a new branch for your feature or fix.
- Make your changes and commit them with a meaningful commit message.
- Push your changes to your fork on GitHub.
- Open a pull request against the main branch of the official repo.
- Follow the code style and conventions used throughout the existing codebase.
- Include comments in your code as necessary.
- Document each function with input and output arguments (include types) and the purpose of the function or class.
- Write tests for any new code, and ensure all tests pass before submitting a pull request.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Feel free to discuss any new ideas on the Discussions tab
- Open a new issue on GitHub with a detailed description of the feature.
- Include the steps that it would enhance, and the possible benefits.
- One pull request for one feature/fix. Do not mix multiple subjects into a single PR.
- Update the
README.mdor documentation as necessary with your changes. - Delete your branch once changes have been merged.
By participating in this project, you are expected to uphold our Code of Conduct.