Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 2.17 KB

CONTRIBUTING.md

File metadata and controls

83 lines (51 loc) · 2.17 KB

Contributing to Python Code Quality Analyzer

Thank you for your interest in contributing to the Python Code Quality Analyzer! We welcome contributions from everyone. Below are the guidelines to help you get started.

How to Contribute

1. Fork the Repository

Fork the repository to your GitHub account by clicking the "Fork" button on the top right of the project page.

2. Clone the Forked Repository

Clone your forked repository to your local machine:

git clone https://github.com/your-username/python-code-quality-analyzer.git
cd python-code-quality-analyzer

3. Create a New Branch

Create a new branch for your feature or bugfix:

git checkout -b your-branch-name

4. Make Changes

Make your changes in the new branch. Ensure that your code follows the coding standards and practices used in the project.

5. Run Tests

Before submitting your changes, run the tests to ensure everything works as expected:

python -m unittest discover -s tests

6. Commit Your Changes

Commit your changes with a clear and concise commit message:

git add .
git commit -m "Description of the changes"

7. Push to Your Fork

Push your changes to your forked repository:

git push origin your-branch-name

8. Create a Pull Request

Go to the original repository and click the "New Pull Request" button. Make sure to fill in all the necessary details and link any related issues.

Coding Standards

  • Follow PEP 8 guidelines for Python code.
  • Use descriptive variable and function names.
  • Write clear and concise commit messages.

Pull Request Guidelines

  • Ensure that your PR is based on the main branch.
  • Make sure your changes don’t introduce any new issues.
  • Provide a detailed description of what your PR does and how it has been tested.
  • Include screenshots, if applicable, to demonstrate the new functionality.

Reporting Issues

If you find a bug or have a feature request, please open an issue on GitHub.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.