Skip to content

Latest commit

 

History

History
110 lines (75 loc) · 6.27 KB

CONTRIBUTING.md

File metadata and controls

110 lines (75 loc) · 6.27 KB
Raw

Contributing to MapTool

The following is a set of guidelines for contributing to MapTool. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document via a pull request.

Table of Contents

Code of Conduct

How Can I Contribute?

Styleguides

Asking Questions

Code of Conduct

This project and everyone participating in it is governed by the RPTools Code Of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

Before submitting a Bug Report

  • 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 rather than opening a new one.

How do I Submit a Bug Report?

Bugs are tracked as GitHub Issues. To create a Bug Report use the Bug Report Issue Template. Explain the problem and include additional details to help maintainers reproduce the problem.

  • Use a clear descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as much detail as possible. This will help us find and fix the problem faster.
  • Explain which behavior you expected to see and why
  • Include screenshots and animated GIFs (where relevant) which show you following the steps and the error that occurred.
  • If a problem wasn't triggered by a specific action, describe what you were doing before the problem happened.
  • Provide the details of the Operating System and MapTool version you are running.

Provide more context by answering these questions:

  • Did the problem start happening recently, for example after upgrading to a new version, or was this always a problem?
  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.
  • If the problem is related to assets (for example images) does the problem happen with all assets of this type or only certain ones?

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion/feature request for MapTool, including completely new features and minor improvements to existing functionality.

Before Suggesting an Enhancement.

  • Perform a cursory search to see if the problem has already been reported.

How Do I Submit an Enhancement Suggestion?

Feature requests are tracked as GitHub Issues. To create a Feature Request use the Feature Request Issue Template.

Explain your request

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the enhancement in as much detail as possible.
  • Provide specific examples to demonstrate
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help to demonstrate the steps or point out how things could work.
  • Explain why this enhancement would be useful to other MapTool users.
  • Specify which version of MapTool you are using.

Your First Code Contribution

Unsure where to begin contributing code to MapTool? You can start by looking through these a good first issue and up for grabs issues.

  • Good First Issues - issues which should be good for people who are not yet familiar with MapTool code base.
  • Up For Grabs Issues - issues which require a little but not much familiarity with the MapTool code base and don't require extensive modifications.

Local Development

MapTool can be developed locally, for instructions on how to do this see Contributor Setup Instructions For MapTool

Pull Requests

Please follow these steps to have your contribution considered by the maintainers:

  1. Fill out the relevant details in the pull request template.
  2. Follow the styleguides
  3. After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Coding Styleguids

Please follow the Coding Styleguides to ensure that the codebase is consistent which makes it easier to read and maintain for everyone.

Asking Questions

If you have questions not answered in these guidelines, need further help getting started, or need help working on an issue then you can