Skip to content

Latest commit

 

History

History
118 lines (69 loc) · 6 KB

CONTRIBUTING.md

File metadata and controls

118 lines (69 loc) · 6 KB
Raw

Contributing

Communicating with Us

We can be reached via creating an issue or Github Discussions if it is available for this repository.

DEPRECATION NOTICE : We also have a Spectrum Chat, however this is deprecated and will become read-only on 2021, August 10th.

Licensing

See the LICENSE file for our project's licensing. We will ask you to confirm the licensing of your contribution.

We may ask you to sign a Contributor License Agreement (CLA) for larger changes.

Issues

Issues are very valuable to this project.

  • Ideas are a valuable source of contributions others can make
  • Problems show where this project is lacking
  • With a question you show where contributors can improve the user experience and/or documentation

Thank you for creating them.

Pull Requests

Pull requests are, a great way to get your ideas into this repository.

When deciding if I merge in a pull request I look at the following things:

Does it state intent

You should be clear which problem you're trying to solve with your contribution.

For example:

Add link to code of conduct in README.md

Doesn't tell me anything about why you're doing that

Add link to code of conduct in README.md because users don't always look in the CONTRIBUTING.md

Tells me the problem that you have found, and the pull request shows me the action you have taken to solve it.

Is it of good quality

  • There are no spelling mistakes
  • It reads well
  • For english language contributions: Has a good score on Grammarly or Hemingway App
  • For code contributions: It should minimally pass the automated code quality checks such as linting and tests, as well was having new tests of its own.

Does it move this repository closer to my vision for the repository

The aim of this repository can be found in README.md

Does it follow the contributor covenant

This repository has a code of conduct, This repository has a code of conduct, I will remove things that do not respect it.

Getting Started

Ready to make a change? Fork the repo

Fork using GitHub Desktop:

Fork using the command line:

  • Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.

Fork with GitHub Codespaces (if available for this repository):

Make your update:

Make your changes to the file(s) you'd like to update.

  • Are you making changes to the application code? See README.md for more information on how to run this project locally.
  • Are you contributing to documentation in this repository? We use GitHub Markdown.

Open a pull request

When you're done making changes and you'd like to propose them for review, use the pull request button to open your PR (pull request).

Submit your PR & get it reviewed

  • Once you submit your PR, core contributors from this repository will review it with you. The first thing you're going to want to do is a self review.
  • After that, we may have questions, check back on your PR to keep up with the conversation.
  • Did you have an issue, like a merge conflict? Check out our git tutorial on how to resolve merge conflicts and other issues.

Reviewing

We aim to review every single PR. The purpose of reviews is to create the best content we can for people who use and/or build on our product.

💛 Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
💛 Reviews discuss content, not the person who created it.
💛 Reviews are constructive and start conversation around feedback.

Self review

You should always review your own PR first.

For content changes, make sure that you:

  • Confirm that the changes address every part of the content design plan from your issue (if there are differences, explain them).
  • Review the content for technical accuracy.
  • Copy-edit the changes for grammar, spelling.
  • Check that all of your changes render correctly in the deploy preview.
  • If there are any failing checks in your PR, troubleshoot them until they're all passing.

Suggested changes

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.

Attribution

This CONTRIBUTING.md was written with much reference to materials from https://gist.github.com/PurpleBooth/b24679402957c63ec426 and https://github.com/github/docs/blob/main/CONTRIBUTING.md