Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (48 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

58 lines (48 loc) · 2.05 KB
Raw

Contributing Guide

First off, thank you for considering contributing to this project! It's people like you that make the open-source community such an amazing place to learn, inspire, and create

Table of Contents

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please be respectful and professional in all interactions

How Can I Contribute ?

Reporting Bugs

If you find a bug, please open an Issue first. When reporting a bug, please include:

  • A clear, descriptive title
  • Steps to reproduce the problem
  • Expected vs. Actual behavior
  • Your environment details (OS, Python version, Django version, etc.)

Suggesting Enhancements

We love new ideas! If you want to suggest a new feature:

  1. Open an Issue titled [Feature Request] Your Idea
  2. Explain why this feature would be useful and how it should work

Pull Requests

If you are ready to write code, please follow these steps:

  1. Fork the Project
  2. Create your Feature Branch:
   git checkout -b feature/AmazingFeature
  1. Commit your Changes: Make sure your commit messages are descriptive
   git commit -m 'Add some AmazingFeature'
  1. Push to the Branch:
   git push origin feature/AmazingFeature
  1. Open a Pull RequestDescribe the changes you made and link to any related issues

Style Guide

To maintain code quality, please ensure:

  • Your code follows PEP 8 standards
  • You include tests for any new functionality
  • You use django-environ for any environment variable management (if applicable)
  • All new functions/classes include docstrings

Contact

If you have questions, feel free to reach out via GitHub Issues or contact me at 2yt.dev.con@gmail.com