badblocks/pkmntrade.club
1
1
Fork 0
Code Issues 14 Pull requests Projects 1 Releases Packages Wiki Activity

Update README and CONTRIBUTING

Browse source
This commit is contained in:
badblocks 2025-04-16 23:27:27 -07:00
parent 318571bb7e
commit 633c1e87e8
2 changed files with 163 additions and 111 deletions
Download patch file Download diff file Expand all files Collapse all files

37
CONTRIBUTING.md
View file

@ -1,5 +1,36 @@
# Contributing
# Contributing to PKMN Trade Club
Thank you for help improving DjangoX. All kinds of contributions are welcome. Please note that this starter project is *intentionally* basic: I don't plan to add environment variables, Docker, or other production-appropriate features as I feel they will overwhelm beginners. But I'm open to suggestions!
Thank you for your interest in contributing to PKMN Trade Club! Your feedback, ideas, and contributions are vital to making this project even better. At this stage, we actively welcome issues and feature requests, and we may accept code contributions in the future.
Please submit an Issue or even better a PR and I'll review :)
## Ways to Contribute
There are several ways you can help:
- **Issues & Feature Requests:**
Found a bug or have an idea for a new feature? Please open an issue detailing the problem or your suggestion.
- Provide a clear and concise description.
- Include steps to reproduce the bug (if applicable).
- Share relevant environment details (OS, Python/Django versions, etc.).
- Attach any relevant logs or screenshots.
- **Documentation & Discussions:**
Contributions to documentation, tutorials, or discussions can have a great impact on our project's success. Feel free to suggest improvements or ask questions in the issues section.
## Code Style Guidelines
- Write clear, descriptive commit messages.
- Adhere to [PEP 8](https://www.python.org/dev/peps/pep-0008/) for Python code.
- Follow Django best practices for project structure, views, models, and templates.
- Ensure code changes are tested and documented.
## Communication
If you have questions or need assistance on how to contribute, please open an issue. We value a collaborative and respectful community, and your input is always welcome.
## License
By contributing, you agree that your contributions will be licensed under the project's MIT License.
---
Thank you for helping improve PKMN Trade Club!