CONTRIBUTING.md (1166B)
1 # Contributing to Pytml 2 3 First off, thank you for considering contributing to Pytml! 🎉 4 5 The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment. 6 7 ## How Can I Contribute? 8 9 ### Reporting Bugs 10 11 - Check if the bug has already been reported in [Issues](https://github.com/nodex-ar/pytml/issues). 12 - If not, open a new issue with a clear title and description. 13 - Include steps to reproduce, expected behavior, and actual behavior. 14 - Add screenshots or code snippets if possible. 15 16 ### Suggesting Enhancements 17 18 - Open an issue with the label `enhancement`. 19 - Explain why this enhancement would be useful to most Pytml users. 20 21 ### Pull Requests 22 23 1. Fork the repository. 24 2. Create a new branch (`git checkout -b new`). 25 3. Make your changes. Keep them focused on one thing. 26 4. Test your changes locally. 27 5. Commit with a clear message (`git commit -m 'Add some amazing feature'`). 28 6. Push to your branch (`git push origin new`). 29 7. Open a Pull Request against the `main` branch. 30 31 ## Development Setup 32 33 1. Clone your fork: 34 ```bash 35 git clone https://github.com/nodex-ar/pytml.git 36 cd pytml