From c2d22d478c15ac9e8c7cbd19df786350b843eaea Mon Sep 17 00:00:00 2001 From: leafspark <78000825+leafspark@users.noreply.github.com> Date: Sun, 4 Aug 2024 18:44:16 -0700 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f155696 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,42 @@ +# Contributing to AutoGGUF + +First off, thanks for taking the time to contribute! 🎉👍 + +## How Can I Contribute? + +### Reporting Bugs + +- Use the issue tracker to report bugs +- Describe the bug in detail +- Include screenshots if possible + +### Suggesting Enhancements + +- Use the issue tracker to suggest enhancements +- Explain why this enhancement would be useful + +### Your First Code Contribution + +1. Fork the repo +2. Create your feature branch (`git checkout -b feature/AmazingFeature`) +3. Commit your changes (`git commit -m 'Add some AmazingFeature'`) +4. Push to the branch (`git push origin feature/AmazingFeature`) +5. Open a Pull Request + +## Styleguides + +### Git Commit Messages + +- Use the present tense ("Add feature" not "Added feature") +- Use the imperative mood ("Move cursor to..." not "Moves cursor to...") +- Limit the first line to 72 characters or less + +### Python Styleguide + +- Follow PEP 8 +- Use meaningful variable names +- Comment your code, but don't overdo it + +## Questions? + +Feel free to contact the project maintainers if you have any questions.