Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.38 KB

Contributing to Jaxampler

First of all, thank you for considering contributing to Jaxampler! 🌟 Your help is essential for making it a better project.

How to Contribute

Issues

  • Report issues or bugs you've discovered. Be as specific as possible about how to reproduce the problem.
  • Suggest enhancements or new features you would like to see in Jaxampler.

Pull Requests

  • Fix bugs or implement new features. Please, first discuss the change you wish to make via an issue.
  • Improve documentation to make it easier for new users to get started.

Contribution Guidelines

  1. Fork the repository on GitHub.
  2. Clone the project to your machine.
  3. Create a new branch and make your changes.
  4. Commit changes to your branch.
  5. Push your work back up to your fork.
  6. Submit a Pull Request so we can review your changes.

Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.

Setting Up Your Environment

  1. Set up a Python development environment (preferably using a virtual environment).
  2. Install dependencies: pip install -r requirements.txt

Running Tests

Before submitting your changes, run all the tests to ensure your changes don't break existing functionality.

python3 -m pytest