Skip to content

Latest commit

 

History

History
53 lines (33 loc) · 1.98 KB

CONTRIBUTING.md

File metadata and controls

53 lines (33 loc) · 1.98 KB

Contributing to DjangoWiz

First off, thank you for considering contributing to DjangoWiz! Your involvement is essential for the success of this project.

How to Contribute

Reporting Issues

If you find a bug or have a question, please check the existing issues before submitting a new one. If your issue or question hasn't been addressed, feel free to open a new issue. When reporting issues, please include:

  • A clear and descriptive title.
  • A detailed description of the problem.
  • Steps to reproduce the issue.
  • Any relevant screenshots or code snippets.

Suggesting Features

We welcome feature suggestions! To suggest a new feature, please open an issue with the following information:

  • A clear and descriptive title.
  • A detailed description of the proposed feature.
  • Any additional context or benefits the feature would provide.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch from the main branch: git checkout -b feature/your-feature-name.
  3. Make your changes.
  4. Test your changes to ensure they work as expected.
  5. Commit your changes: git commit -m 'Add some feature'.
  6. Push to the branch: git push origin feature/your-feature-name.
  7. Open a pull request against the main branch.

Code Style

  • Follow the existing code style.
  • Ensure your code is well-documented.
  • Write clear and concise commit messages.

Testing (WIP)

Make sure to add and run tests for your changes. We rely on tests to ensure the codebase remains stable and reliable.

Documentation

Please update the documentation as necessary to reflect any changes or new features you introduce.

Community

Join the discussion on our GitHub Discussions page. Feel free to ask questions, share ideas, or provide feedback.

Thank you for your contributions!