Skip to content

Latest commit

 

History

History
47 lines (28 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

47 lines (28 loc) · 3.64 KB
Raw

Welcome to the Crosswalker contributing guide

** Info ** Guide inspired by the Github Contribution Guide

Thank you for investing your time in contributing to Crosswalker! Any contribution you make will be reflected on https://crosswalker.washingtonpost.com/ 🚀.

We adhere to the Github Code of Conduct to keep our community approachable and respectable. Should any community leaders miss anything, any violations of this Code of Conduct can and should be reported to [email protected].

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you.

Pull Request

When you're finished with the changes locally, run npm run commit, this will run some pre-commit and commit hooks that will ask you questions in order to form a proper conventional commit, you may then create a pull request, also known as a PR.

  • Don't forget to link PR to issue if you are solving one. Once you submit your PR, a Crosswalker team member will review your proposal. We may ask questions or request additional information.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Your PR is merged!

Congratulations 🎉🎉 The Washington Post Crosswalker team thanks you ✨.