Skip to content
This repository has been archived by the owner on Jun 29, 2020. It is now read-only.

Latest commit

 

History

History
120 lines (83 loc) · 6.07 KB

CONTRIBUTING.md

File metadata and controls

120 lines (83 loc) · 6.07 KB
Raw

Contributing to MappyPals

When contributing to this repository, check the Trello board (link on Discord) for available tasks. If the task is:

  • Available: Go ahead and claim the task, and proceed to work on a PR
  • Claimed: If someone else has claimed the task, speak with them or one of the project admin. PRs will only be accepted from the person that claimed that task.
  • Non-Existant: If the feature does not appear on trello, discuss it on Discord or speak with a project admin. There may be a good reason this feature is not listed.

The above is to ensure, everyone has the chance to get involved without waiting their time or rushing to add the feature.

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

Trello Process

  1. Staging Area

    • If you have an idea, suggestion or have found a bug in the project. Create a task with a detailed description, if it's a bug add photo, and steps on how to replicate it. We'll then discuss it in the task comment section or on discord. If its approved by the community it will be added to the Tasks(current) area. You can also assign yourself to the task, that way nobody could work on that task but you if its approved.

  2. Tasks (current)

    • This is where you can find available tasks! If you are looking for a new challenge, select a task that excites you, assign your self to it and move it into the In Progress area.
    • NOTE - Don't take tasks that have already been assigned to someone, without their or a project admins approval.

  3. In Progress

    • This is where tasks that are being worked on belong. Drag your task into this section, when you start working on it.
    • NOTE Check out the PR Guide by @Thijs, for more information on our forking/branching and keeping forks synced with the upstream.

  4. Review

    • This is where tasks are place whilst the PR has been submitted and is awaiting approval. Once the code has been reviewed it will be merged and the task can be moved into the Done section.

  5. Done

    • Tasks that have been completed, reviewed and merged can be found in this section.

Pull Request Process

Please checkout the Github Guide created by @thijs, it can be found here

When creating a PR, please ensure the follow have been addressed:

  1. Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations etc.
  2. Ensure the PR comment is documented with the changes you have made, for example updated code isn't really useful.
  3. After you submit the PR, check that Travis successfully built the project and there are no code conflicts, your PR cannot be merged without correcting failures to build or code conflicts.

Code of Conduct

Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

Our Standards

Examples of behaviour that contributes to creating a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for the community
  • Showing empathy towards other community members

Examples of unacceptable behaviour by participants include:

  • The use of sexualized language or imagery and unwelcome sexual attention or advances
  • Trolling, insulting/derogatory comments, and personal or political attacks
  • Public or private harassment
  • Publishing others' private information, such as a physical or electronic address, without explicit permission
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behaviour and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behaviour.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviours that they deem inappropriate, threatening, offensive, or harmful.

Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

Enforcement

Instances of abusive, harassing, or otherwise unacceptable behaviour may be reported by contacting the project team at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

Attribution

This Code of Conduct is adapted from the Contributor Covenant, version 1.4, available at http://contributor-covenant.org/version/1/4