Thank you for your interest in contributing to NextGenJAX! We welcome contributions from the community and are excited to collaborate with you. Please take a moment to review these guidelines to ensure a smooth contribution process.
-
Fork the Repository: Start by forking the NextGenJAX repository to your GitHub account.
-
Clone the Repository: Clone your forked repository to your local machine.
git clone https://github.com/your-username/NextGenJAX.git cd NextGenJAX -
Create a Branch: Create a new branch for your feature or bug fix.
git checkout -b feature/your-feature-name
-
Set Up Development Environment: Install the necessary dependencies and set up your development environment.
pip install -e . pip install -r requirements.txt -
Make Changes: Implement your changes in the appropriate files. Ensure that your code follows the project's coding standards and includes necessary tests.
-
Run Tests: Run the tests to ensure your changes do not break existing functionality.
pytest
-
Commit Changes: Commit your changes with a clear and descriptive commit message.
git add . git commit -m "Add feature: your feature description"
-
Push Changes: Push your changes to your forked repository.
git push origin feature/your-feature-name
-
Create a Pull Request: Open a pull request from your forked repository to the main repository. Provide a detailed description of your changes and any relevant information. Use the Pull Request Template to ensure all necessary information is included.
Please note that by participating in this project, you agree to abide by our Code of Conduct.
If you encounter any issues or have suggestions for improvements, please open an issue in the repository. Use the appropriate issue template:
Provide as much detail as possible to help us understand and address the problem.
If you need help or have questions, feel free to reach out to the community by opening an issue or joining our discussion forums.
Thank you for contributing to NextGenJAX!