CONTRIBUTING.md

Welcome to the 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.

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:

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Getting started

If you would like to add a new feature please submit an issue first that describes the feature in detail. Once there is agreement on the new feature you can continue and submit a pull request.

Issues

Create a new issue

If you spot a problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Solve an issue

Scan through our existing issues to find one that interests you. 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 locally

1. Install Git.

2. Fork the repository.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• 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.

• GitHub Codespaces:

  • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.

3. Create a working branch and start with your changes!

Commit your update

Commit the changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages.

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 for 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 Ably Labs team thanks you! ✨