From 16a1a48a01887563d75bd71ca2b86154785a4176 Mon Sep 17 00:00:00 2001 From: Adil Mohak <60693922+adilmohak@users.noreply.github.com> Date: Wed, 9 Aug 2023 18:11:42 +0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 67 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 67 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f19d3ef --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,67 @@ +# Contributing to django-lms + +Thank you for considering contributing to django-lms! We welcome your contributions to help improve and enhance the project. +Whether you're submitting code, documentation, or bug reports, your help is greatly appreciated. + +Before you start contributing, please take a moment to review the following guidelines. + +## Table of Contents + +- [Code of Conduct](#code-of-conduct) +- [Getting Started](#getting-started) +- [How Can I Contribute?](#how-can-i-contribute) + - [Reporting Bugs](#reporting-bugs) + - [Suggesting Enhancements](#suggesting-enhancements) + - [Pull Requests](#pull-requests) +- [Style Guidelines](#style-guidelines) +- [License](#license) + +## Code of Conduct + +Please review and adhere to our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a positive and respectful atmosphere within the community. + +## Getting Started + +Before contributing, make sure you have the project set up on your local machine. Refer to the README for installation and setup instructions. + +## How Can I Contribute? + +### Reporting Bugs + +Found a bug? Please open an issue on the repository with a detailed description of the problem. Include steps to reproduce it, expected behavior, and any relevant information. + +### Suggesting Enhancements + +Have an idea for an improvement? We'd love to hear it! Open an issue and describe your enhancement suggestion, why you think it would be valuable, and any additional context. + +### Pull Requests + +We welcome pull requests! To contribute code: + +1. Fork the repository. +2. Create a new branch with a descriptive name. +3. Make your changes and ensure that the code passes any existing tests. +4. Write clear and concise commit messages. +5. Push your branch to your fork. +6. Open a pull request to the `main` branch of this repository. + +Please make sure your code adheres to our [style guidelines](#style-guidelines). + +## Style Guidelines + +Maintaining consistent coding style is important for the project's readability. Follow these guidelines when submitting code: + +- Use consistent indentation (spaces). +- Keep lines under 80 characters for code, and under 120 characters for comments and documentation. +- Write clear and descriptive variable and function names. +- Document your code using comments or docstrings. +- Follow the coding conventions used in the existing codebase. + +## License + +By contributing to django-lms, you agree that your contributions will be licensed under the [django-lms's license](https://github.com/adilmohak/django-lms/blob/main/LICENSE). + +--- + +Thank you for contributing to django-lms! +Your support helps make this project better for everyone. If you have any questions, feel free to reach out to the maintainers.