Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (35 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

57 lines (35 loc) · 3.38 KB
Raw

Welcome to ReARM contributing guide

Note: This Contributing guide is based on GitHub Docs Contributing guide.

Thank you for investing your time in contributing to ReARM!

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 file. Here are some resources to help you get started with open source contributions:

Issues

Create a new issue

If you spot a problem with ReARM, first check if a corresponding issue exists in open issues. 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. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

  1. Fork the repository.
  • 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.
  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.

  • 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 ReARM team thanks you ✨.

Once your PR is merged, your changes will be added to the next ReARM release based on TBD model.