Skip to content

Latest commit

 

History

History
68 lines (41 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

68 lines (41 loc) · 4.11 KB
Raw

Welcome to Take a break contributing guide

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

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:

Getting started

This project is accepting both code and non-code contributions. Code contributions include:

  • Bug fixes
  • Code Improvements
  • Feature addition/enhancement

Non-code contributions include:

  • Improving the README and COntribution guidelines.
  • Improvements to the assets used in the project

Issues

Create a new issue

If you experience or identify an issue in the extension, 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 the already raised issues to find one that interests you. You can narrow down the search using labels as filters. 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 Github Desktop or Using the command line.

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

Commit your update

Commit the changes once you are happy with them. Don't forget to self-review to speed up the review process:zap:.

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 I will review your proposal. Based on the changes, I, may ask questions or request additional information.
  • Few changes can be asked 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 🎉🎉 Thank you for contributing to Take a break ✨.

Footnotes

This document was adapted from the open-source contribution guidelines for Github docs..