badbl0cks
9c41f63247
- Dev and prod both now run with the same exact docker configuration, except the .env file copied in. - Removed the `.env` file and added a new `.env.dev` file for development settings, including database configuration and API keys. - Introduced a `.envrc` file for automatic venv activation. - Updated `deploy.sh` to utilize `uv` for running management commands and added a command for building Tailwind CSS. - Created `docker-compose.yml` for local development with PostgreSQL, ensuring proper service dependencies. - Deleted unnecessary files such as `docker-compose_db_only.yml` and `requirements.txt` to streamline the project structure.
36 lines
1.6 KiB
Markdown
36 lines
1.6 KiB
Markdown
# Contributing to PKMN Trade Club
|
|
|
|
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!
|
|
|
|
## 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!
|