Skip to content

Latest commit

 

History

History
38 lines (25 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

38 lines (25 loc) · 1.58 KB

Contribution Guidelines

We welcome and appreciate contributions to Scandocs! Whether you want to report a bug, propose a new feature, or submit a fix, your help is invaluable.

How to Contribute

Reporting Issues

If you encounter any issues or have suggestions for improvement, please open an issue on this repository. Make sure to include:

  • A clear and descriptive title.
  • Details about the problem or enhancement you are suggesting.
  • Steps to reproduce (if applicable).
  • Screenshots or code snippets (if relevant).

Pull Requests

We encourage you to contribute directly by submitting pull requests.

  1. Fork the repository to your GitHub account.
  2. Clone your fork to your local machine: git clone https://github.com/your-username/scandocs.git
  3. Create a new branch for your changes: git checkout -b feature/your-feature or git checkout -b bugfix/your-bug-fix
  4. Make your changes and commit: git commit -m "Description of your changes"
  5. Push the branch to your fork: git push origin feature/your-feature
  6. Open a pull request (PR) against the development branch on this repository.

Please ensure that your pull request:

  • Includes a clear title and description of the changes.
  • References the related issue (if applicable).
  • Follows the coding style and conventions used in the project.
  • Has a well-documented code and, if applicable, includes tests.

License

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

Thank you for contributing to Scandocs!