Skip to content

Latest commit

 

History

History
69 lines (42 loc) · 2.88 KB

CONTRIBUTING.md

File metadata and controls

69 lines (42 loc) · 2.88 KB
Raw
Logo of OnTheSpot

Contributing

Thank you for considering contributing to the OnTheSpot project! We appreciate all contributions.

Before contributing, we encourage you to read our License and ReadMe. If you have any questions not answered by the content of this repository, feel free to contact us.

License

OnTheSpot is open-source software licensed under the GNU General Public License v2.0. By contributing to this project, you agree that your contributions will be licensed under the GPL-2.0 as well.

How to Contribute

We welcome contributions in many forms, including bug reports, feature requests, documentation improvements, and code enhancements. Here's how you can contribute:

Reporting Issues

If you encounter any bugs or have feature requests, please open an issue in this repository. Provide as much detail as possible to help us understand and address your concerns.

Submitting Pull Requests

If you would like to contribute code changes, please follow these steps:

  1. Fork the Repository: Click on the "Fork" button at the top of the repository page to create a copy of the repository in your GitHub account.

  2. Create a Branch: Clone your fork locally and create a new branch for your feature or fix:

    git checkout -b feature/your-feature-name

  3. Make Changes: Implement your changes, following the project's coding standards and guidelines.

  4. Commit Changes: Commit your changes with clear and descriptive commit messages.

    git commit -m "Add feature: description of feature"

  5. Push to GitHub: Push your changes to your forked repository.

    git push origin feature/your-feature-name

  6. Open a Pull Request: Go to the original repository and open a pull request from your branch. Provide a clear description of your changes and any related issues.

Code Review Process

  • Review Time: We aim to review pull requests within a few days, but response times may vary.
  • Feedback: Be prepared to make revisions based on feedback from maintainers and other contributors.
  • Merge Criteria: Pull requests must pass all automated tests and receive approval from at least one maintainer before being merged.

Code Style Guidelines

  • Follow the existing code style and conventions.
  • Write clear, concise, and well-documented code.
  • Include tests when adding new features or fixing bugs.

Contact Us

If you have any questions or need assistance, feel free to contact us.