Skip to content

Latest commit

 

History

History
53 lines (34 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

53 lines (34 loc) · 2.24 KB
Raw

Contributing to Vivid

Thank you for your interest in contributing to Vivid, a Python web framework designed for learning, authored by Navithecoderboi (Navinder Singh). Feel free to reach out via email at [email protected] or on Discord (@navithecoderboi).

Here are some guidelines to help you get started:

1. Issues:

  • If you encounter a bug or have a feature request, please open an issue on the repository.
  • Provide a clear and concise description of the issue, along with steps to reproduce it.
  • Feel free to share your suggestions for fixing the issue or implementing the feature.

2. Pull Requests:

  • Check existing issues before starting a pull request to avoid duplication.
  • If there isn't an issue for your proposed change, create one to discuss it with the maintainers.
  • Fork the repository and create a new branch for your changes.
  • Ensure well-documented code following the existing coding style.
  • Write unit tests for your changes.
  • Submit a pull request to the main repository.

3. Coding Style:

  • Adhere to Python's standard style guide, PEP 8.
  • Use spaces instead of tabs for indentation.
  • Limit lines to 120 characters.
  • Utilize descriptive variable names and docstrings.
  • Apply Black formatter code style.
  • Consider using ruff for additional code quality checks.

4. Contact:

  • Contact the maintainers of Vivid by creating a Discussion on the repository or DMing them on Discord (@navithecoderboi).
  • Join the "Pro Gamerz" Discord server to interact with contributors and maintainers.

We appreciate your contributions to Vivid!

Additional Notes:

  • Feel free to suggest improvements to this contributing guide.
  • We welcome ideas for enhancing Vivid, so share your thoughts without hesitation.

We hope this guide helps you make valuable contributions to Vivid!

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Contact

Contact Navithecoderboi by creating a Discussion on the repository or by DMing on Discord (@navithecoderboi). For bug reports, please open an issue. Additionally, check out Navithecoderboi's portfolio: https://navithecoderboi.me, where you can find a link to the "Pro Gamerz" Discord server.

We code vividly!