Skip to content

Latest commit

 

History

History
51 lines (40 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

51 lines (40 loc) · 1.69 KB
Raw

Contributing to SonarGit

We appreciate your interest in contributing to SonarGit Scraper! Your assistance is crucial for improving and enhancing this project. Please review the guidelines below before making your contribution.

How to Contribute

  • Fork this repository to your GitHub account.

  • Clone the forked repository to your local machine.

    $ git clone https://github.com/luckyaxl/sonargit.git
$ cd sonargit

  • Create a new branch for your contribution.

    $ git checkout -b feature/your-feature

  • Make changes and commit them with a clear, concise message.

    $ git add .
$ git commit -m "feat: Add your descriptive commit message here"

  • Push your changes to your fork on GitHub.

    $ git push origin feature/your-feature

  • Open a pull request against the main branch of the original repository.

Code Guidelines

Please follow these guidelines when contributing code:

  • Follow existing coding style and conventions.
  • Write clear, concise commit messages.
  • Provide appropriate comments in the code where necessary.
  • Test your changes before submitting a pull request.

Submitting a Bug Report

If you encounter a bug:

  1. Describe the bug and provide steps to reproduce it.
  2. Include the expected and actual behavior.
  3. Specify the SonarGit version.
  4. Include relevant error messages or screenshots.

Feature Requests

For new feature ideas, open an issue and provide details about the proposed enhancement.

License

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

Thank you for contributing to SonarGit!