Skip to content

Latest commit

 

History

History
27 lines (21 loc) · 1.94 KB

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 1.94 KB

Contributions Welcome

First off, thank you for considering contributing to this repository! This infinite-wish-board was first made for a hack day for Make-A-Wish.

If you're just looking for quick feedback for an idea, proposal, or bug, feel free to open an issue.

Follow the contribution workflow for submitting your changes.

Contribution Workflow

This project uses the “fork-and-pull” development model. Follow these steps if you want to merge your changes into the project:

  1. Within your fork of infinite-wish-board, create a branch for your contribution and use a meaningful name.
  2. (Optional) Claim the bug or feature you are working on as to hopefully avoid duplicate effort. If any existing claims seem stale, feel free to continue work either way. You can claim in one of two ways:
    • Comment on the issue ticket to give intent to work on it and/or be assigned on the ticket.
    • Open a draft PR referencing the Bug/Feature Issue number.
  3. Create your contribution, meeting all contribution quality standards.
  4. Create a pull request against the master branch.
  5. Before we merge your PR, we may ask you to catch your fork up with what is on master. We are following the merge strategy to catch up your fork.
  6. Once the pull request is approved, one of the maintainers will merge it and build a release as needed.

Contribution Quality Standards

Your contribution needs to meet the following standards:

  • Separate each logical change into its own commit.
  • Add a descriptive message for each commit. Follow commit message best practices.
  • If you are resolving an issue, mention the issue # in the commit body.
  • Document your pull requests. Include the reasoning behind each change and the testing done.
  • To the extent possible, follow existing code and documentation style and practices.