Skip to content

Latest commit

 

History

History
66 lines (40 loc) · 4.7 KB

CONTRIBUTING.md

File metadata and controls

66 lines (40 loc) · 4.7 KB

Welcome to Le Git Graph contributing guide

Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on Chrome Web Store and Firefox Addons Hub ✨.

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 extension development:

Getting started

Extension installed via Chrome Web Store or Firefox AddOns Hub are mostly meant for end user consumption. For development, the extension is to be loaded in a different way. To start with, go ahead with the following steps:

  1. Uninstall or disable Le Git Graph if already installed via Chrome Web Store or Firefox AddOns Hub.
  2. Fork this repository.
  3. Clone the forked repository. (How?)
  4. Load the extension from the cloned repository. Follow these steps for Chrome and these steps for Firefox.
  5. Make changes in the source code and refresh the extension inside the browser to see changes.

Issues

Create a new issue

If you spot a problem with Le Git Graph, 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, issues are usually not assigned to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Developer documentation

Developer documentation provides an idea on how the extension is working currently. It is strongly suggested to have a brief look at the documentation before proceeding to actively work on the source code as it will help your work be a lot smoother.

Bug fixes

This project is not following unit tests (at least yet). Kindly make sure the fixes are stable by testing with relevant testcases depending on the change you worked on.

Commit your update

Commit the changes once you are happy with them.

Pull Request

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

  • 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, your proposal will be reviewed. There might be questions or requests for additional information.
  • You maybe asked 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.
  • 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 🎉🎉 Big Thanks to you ✨.

Once your PR is merged, your contributions will be publicly visible with the next version release.