Thank you for your interest in contributing to our project! To ensure a smooth contribution process, please follow the guidelines below.
- Reporting Issues: If you encounter a bug or have a suggestion, please open an issue on GitHub and provide as much detail as possible.
- Submitting Code: To submit code changes:
- Fork the Repository: Start by forking the repository to your GitHub account.
- Create a New Branch: Establish a new branch in your forked repository specifically for your development work.
- Develop: Before you begin developing, please review our requirements in the pull request template. Make your changes or add new features in this branch.
- Git Rebase: Compress all your commits in one.
- Submit a Pull Request: Once you are ready, send a pull request from your branch. Ensure that your pull request details the changes made and their purpose.
- Additional Setup Requirements:
- Coding Style: Except for specific requirements, please follow the PEP8 standard for development.
- The specific requirements are as follows
- Docstring: Use the Numpy style for docstrings.
- Max Line Length: Keep the maximum line length to 120 characters.
- The specific requirements are as follows
- Documentation: Ensure all new features and changes are documented.
- All code submissions will be reviewed by a team member.
- The review process may take some time; please be patient.
- Please read and adhere to our [Code of Conduct](link to code of conduct). We are committed to maintaining a respectful and inclusive community.