Skip to content

Latest commit

 

History

History
88 lines (55 loc) · 5.11 KB

contributing.md

File metadata and controls

88 lines (55 loc) · 5.11 KB
Raw

Welcome to awesome-orgs contributing guide

Thank you for investing your time in contributing to our project! ✨

Read our Code of Conduct to keep our community approachable and respectable.

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

Criteria

Before jumping into the contribution workflow, please review the following criteria we expect for an awesome org:

Must have

  • More than one actively maintained project
  • Variety of useful or awesome repositories

Nice to have

  • Branding, website, social media
  • Organization README
  • Strong community
  • Sponsoring other organizations or users on GitHub
  • Being sponsored on GitHub
  • Currently active

New contributor guide

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 doc, 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. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes in the UI

Click Make a contribution at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the .md file where you can make your changes and create a pull request for a review.

Make changes in a codespace

For more information about using a codespace for working on GitHub documentation, see "Working in a codespace."

Make changes locally

  1. Fork the repository.
  1. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Docs 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 team thanks you ✨.

Once your PR is merged, your contributions will be publicly visible on the readme.