Skip to content
This repository has been archived by the owner on Feb 13, 2023. It is now read-only.

Latest commit

 

History

History
64 lines (47 loc) · 3.13 KB

CONTRIBUTING.md

File metadata and controls

64 lines (47 loc) · 3.13 KB
Raw

Contributing

👋 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Submitting a pull request

Pull Requests are used for adding new functionality, fixing bugs, improving documentation, and improving the developer experience overall.

With write access:

  1. Clone the repository (only if you do not have write access)
  2. Run npm install
  3. Create a new branch: git checkout -b <username>/<my-branch-name>
  4. Setup a GitHub App and follow the instructions in the README
  5. Configure your .env using the .env.example as a template
  6. Make your change
  7. Push and submit a pull request
  8. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Without write access:

  1. Fork and clone the repository
  2. Run npm install
  3. Create a new branch: git checkout -b <username>/<my-branch-name>
  4. Setup a GitHub App and follow the instructions in the README
  5. Configure your .env using the .env.example as a template
  6. Make your change
  7. Push to your fork and submit a pull request
  8. Pat your self on the back and wait for your pull request to be reviewed and merged.:tada:

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write good commit messages.
  • Please honor the <username>/<branch-name> naming convention to help with sorting branches in the UI
  • Test your changes. Many users depend on this app's reliability. Please be sure to test your changes to make sure they do not break the functionality

Work in Progress pull requests are also welcome to get feedback early on, or if there is something blocking you.

  • Create a branch with a name that identifies the user and nature of the changes (similar to <username>/<branch-purpose>)
  • Open a pull request and request a review from a member of the @github/ps-delivery team

Releasing

If you are the current maintainer of this project:

  1. Observe Semantic Versioning when deciding on a version number to move to
  2. Review the autogenerated draft Release with the summarized changelog for accuracy
  3. Ensure you check the box for publishing to the marketplace
  4. Gather consensus from other maintainers
  5. Release it and make it official 🚀

Resources