Skip to content
This repository has been archived by the owner on Dec 7, 2021. It is now read-only.

Latest commit

 

History

History
149 lines (104 loc) · 5.64 KB

CONTRIBUTING.md

File metadata and controls

149 lines (104 loc) · 5.64 KB

Contributing to Tabio

First off, thank you for considering contributing to Tabio! 🎉

This should be as easy as possible for you but there are a few things to consider when contributing. The following guidelines for contribution should be followed if you want to submit a pull request or open an issue.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Table of Contents

TL;DR

  • Creating an Issue or Pull Request requires a GitHub account.
  • Issue reports should be clear, concise and reproducible. Check to see if your issue has already been resolved in the master branch or already reported in the GitHub Issue Tracker.
  • Pull Requests must adhere to the existing coding style.
  • IMPORTANT: By submitting a patch, you agree to allow the project owner to license your work under the same license as that used by the project.

Contributing

The issue tracker is the preferred channel for bug reports, feature requests and submitting pull requests.

Bug Reports

A bug is a demonstrable problem that is caused by the code in the repository.

Guidelines for bug reports:

  1. Use the GitHub issue search — check if the issue has already been reported.
  2. Check if the issue has been fixed — try to reproduce it using the latest version of the extension.
  3. Isolate the problem — find a way to demonstrate your issue. Provide either screenshots or code samples to show you problem.

A good bug report shouldn't leave others needing to chase you up for more information. Please try to be as detailed as possible in your report.

  • What is your environment?
  • What steps will reproduce the issue?
  • What browser(s) versions experience the problem?
  • What would you expect to be the outcome?

All these details will help people to fix any potential bugs.

Example:

Short and descriptive example bug report title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.
  4. Attach screenshots, etc.

Any other information you want to share that is relevant to the issue being reported.

Feature Requests

Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Please provide as much detail and context as possible.

Pull Requests

  • PRs for bug fixes are always welcome.
  • PRs for improving the documentation are always welcome.
  • PRs for enhancing the interface are always welcome.

Good pull requests - patches, improvements, new features - are a fantastic help. They should remain focused in scope and avoid containing unrelated commits.

Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.

Please adhere to the coding conventions used throughout a project (indentation, accurate comments, etc.) and any other requirements (such as test coverage).

Follow this process if you'd like your work considered for inclusion in the project:

  • Fork the project, clone your fork, and configure the remotes:
# Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/tabio
# Navigate to the newly cloned directory
cd tabio
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/colebemis/tabio
  • If you cloned a while ago, get the latest changes from upstream:
git checkout master
git pull upstream master
  • Create a new topic branch (off of the master branch) to contain your feature, change, or fix:
git checkout -b <topic-branch-name>
  • Install the npm dependencies:
npm install
  • Start the webpack build. Webpack will rerun when edits are made:
npm start

  • Load the extension:

    • Open Chrome and go to chrome://extensions.
    • Enable Developer mode by clicking the checkbox in the top right.
    • Click Load unpacked extension.
    • Find and select the dist directory of this project.

  • Commit your changes in logical chunks. This project adheres to the Conventional Commits Specification for commit messages. Running npm run cm instead of git commit will guide you through the commit process. Use Git's interactive rebase feature to tidy up your commits before making them public.

  • Locally merge (or rebase) the upstream development branch into your topic branch:

git pull [--rebase] upstream master
  • Push your topic branch up to your fork:
git push origin <topic-branch-name>