Here is a set of guidelines which can assist you in contributing towards this project. We’d appreciate it if you could help us in improving our project which is hosted in SEProjGrp5/MapThat on github.
We request you to please follow the Code of Conduct that we have created which is located here : https://github.com/SEProjGrp5/MapThat/blob/main/CODE_OF_CONDUCT.md
This section guides you through submitting a bug report for this project. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior and find related reports. Fill out the required template, the information it asks for helps us resolve issues faster.
- Check the Debugging guide for the corresponding project. You might be able to find the cause of the problem and fix things yourself.
- Check the FAQs on the forum for a list of common questions and problems.
- Determine which repository the problem should be reported in.
- Perform a cursory search to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.
Bugs are tracked as GitHub issues. After you've determined which repository your bug is related to, create an issue on that repository. Explain the problem and include additional details to help maintainers reproduce the problem:
-
Use a clear and descriptive title for the issue to identify the problem.
-
Describe the exact steps which reproduce the problem in as many details as possible.When listing steps, don't just say what you did, but explain how you did it.
-
Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
-
Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
-
Explain which behavior you expected to see instead and why.
-
If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened and share more information using the guidelines below.
This section guides you through submitting an enhancement suggestion for our project, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion and find related suggestions . Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
- Check the Debugging guide for the corresponding project and look for the enhancement that is already available.
- Check the FAQs on the forum for a list of common questions and problems.
- Determine which repository the enhancement should be suggested in.
- Perform a cursory search to see if the enhancement has already been suggested.
Enhancement suggestions are tracked as GitHub issues. After you've determined which repository your enhancement is related to, create an issue on that repository and provide the following information :
-
Use a clear and descriptive title for the issue to identify the suggestion.
-
Provide a step-by-step description of the suggested enhancement in as many details as possible.
-
Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
-
Describe the current behavior and explain which behavior you expected to see instead and why.
-
List some other text editors or applications where this enhancement exists.
The process described here has several goals:
- Maintain the project’s quality
- Fix problems that are important to users
- Engage the community in working toward the best possible solution
- Enable a sustainable system for the project’s maintainers to review contributions