Skip to content

CONTRIBUTING

Jump to bottom Edit New page
Herbert Rocha edited this page Dec 20, 2018 · 1 revision

How to contribute to Map2Check Tool

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Did you find a bug?

  • Ensure the bug was not already reported by searching on GitHub under Issues.

  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

  • If possible, use the relevant bug report templates to create the issue, and paste the content into the issue description.

  • For more detailed information on submitting a bug report and creating an issue, visit our reporting guidelines.

Did you write a patch that fixes a bug?

  • Open a new GitHub pull request with the patch.

  • Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.

Did you fix whitespace, format code, or make a purely cosmetic patch?

Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of Map2Check will generally not be accepted (read more about our rationales behind this decision based on Rails Guide).

Do you intend to add a new feature or change an existing one?

  • Suggest your change by mail and start writing code.

  • Do not open an issue on GitHub until you have collected positive feedback about the change. GitHub issues are primarily intended for bug reports and fixes.

Do you have questions about the source code?

  • Ask any question about how to use Map2Check by mail.

Do you want to contribute to the Map2Check documentation?

  • You can help improve the Map2Check guides by making them more coherent, consistent, or readable, adding missing information, correcting factual errors, fixing typos, or bringing them up to date with the latest edge Map2Check.

  • You can send us PR request in our website

Map2Check is a volunteer effort. We encourage you to pitch in and join the team!

Attribution

This document is adapted from the Ruby on Rails, available at https://github.com/rails/rails/

Thanks!

Map2Check Team

Add a custom footer
Add a custom sidebar
Clone this wiki locally