Skip to content

Latest commit

 

History

History
214 lines (167 loc) · 10.2 KB

CONTRIBUTING.md

File metadata and controls

214 lines (167 loc) · 10.2 KB
Raw

Contribution Guidelines

Welcome, and thank you for your interest in contributing to my project!

There are many ways in which you can contribute, beyond writing code. The goal of this document is to provide a high-level overview of how you can get involved.

Table of Contents

Asking Questions

Have a question? Rather than opening an issue, please ask me directly on [email protected].

Providing Feedback

Your comments and feedback are welcome. You can leave your feedbak on [email protected] or do it on Microsoft Edge Add-ons Webstore, Chrome Extensions Webstore or Mozilla Add-ons Webstore

Reporting Issues

Have you identified a reproducible problem in the extension? Have a feature request? I'd like to hear it! Here's how you can make reporting your issue as effective as possible.

Look For an Existing Issue

Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.

Be sure to scan through the feature requests.

If you find your issue already exists, make relevant comments and add your reaction. Use a reaction in place of a "+1" comment:

  • 👍 - upvote
  • 👎 - downvote

If you cannot find an existing issue that describes your bug or feature, create a new issue using the guidelines below.

Writing Good Bug Reports and Feature Requests

File a single issue per problem and feature request. Do not enumerate multiple bugs or feature requests in the same issue.

Do not add your issue as a comment to an existing issue unless they are the same ones. Many issues look similar, but have different causes.

The more information you can provide, the more likely someone will be successful at reproducing the issue and finding a solution.

Please include the following with each issue:

  • Current version of the extension
  • Your current browser and OS name
  • Reproducible steps (1... 2... 3...) that cause the issue
  • What you expected to see, versus what you actually saw
  • Images, animations, or a link to a video showing the issue occurring

Final Checklist

Please remember to do the following:

  • Search the issue repository to ensure your report is a new issue
  • Separate issues reports
  • Include as much information as you can to your report

Don't feel bad if the developers can't reproduce the issue right away. They will simply ask for more information!

Follow Your Issue

Once your report is submitted, be sure to stay in touch with the devs in case they need more help from you.

Contributing to the codebase

If you are interested in writing code to fix issues or implement new awesome features you can follow these guidelines to get a better result

Deploy test version on your browser

  1. Clone repository to local storage using Git

    git clone https://github.com/xfox111/TabsAsideExtension.git

  2. Enable Developers mode on your browser extensions page

  3. Click "Load unpacked" button and navigate to the extension root folder (contains manifest.json)

  4. Done!

Next time you make any changes to the codebase, reload the extension by toggling it off and on or by pressing "Reload" button on the extensions list page

Note: You can also check this article to get more information about debugging web extensions

Development workflow

This section represents how contributors should interact with codebase implementing features and fixing bugs

  1. Getting assigned to the issue
  2. Creating a repository fork
  3. Making changes to the codebase
  4. Creating a pull request to master
  5. Reviewing & completing PR
  6. Done

Release

The next stage is the release. Release performs on every push to master (which makes functional changes to the source code). Release performs manually by @XFox111 into: Chrome webstore, Edge webstore and GitHub releases

Coding guidelines

Indentation

We use tabs, not spaces.

Names

The project naming rules inherit .NET Naming Guidelines. Nevertheless there'is some distinction with the guidelines as well as additions to the one:

Comments

Leave as more comments as you can. Remember: the more detailed documentation your code has the less programmers will curse you in the future

Strings

Use "double quotes" wherever it's possible

Style

  • Prefer to use lambda functions
  • Put curly braces on new lines

    • Wrong:

      if (condition) {
    ...
}

    • Correct:

      if (condition)
{
    ...
}
  • Put spaces between operators and before braces in methods declarations, conditionals and loops
    • Wrong:
      • y=k*x+b
      • function FunctionName()
    • Correct:
      • y = k * x + b
      • function FunctionName ()
  • Use ternary conditionals wherever it's possible

    • Wrong:

      var s;
if (condition)
  s = "Life";
else
  s = "Death";

    • Correct:

      var s = condition ? "Life" : "Death";
  • Do not surround loop and conditional bodies with curly braces if they can be avoided

    • Wrong:

      if (condition)
{
    console.log("Hello, World!");
}
else
{
    return;
}

    • Correct

      if (condition)
    console.log("Hello, World!");
else
    return;

Finding an issue to work on

Check out the full issues list for a list of all potential areas for contributions. Note that just because an issue exists in the repository does not mean we will accept a contribution. There are several reasons we may not accept a pull request like:

  • Performance - One of Tabs Aside core values is to deliver a lightweight extension, that means it should perform well in both real and test environments.
  • User experience - Since we want to deliver a lightweight extension, the UX should feel lightweight as well and not be cluttered. Most changes to the UI should go through the issue owner and project owner (@XFox111).
  • Architectural - Project owner needs to agree with any architectural impact a change may make. Such things must be discussed with and agreed upon by the project owner.

To improve the chances to get a pull request merged you should select an issue that is labelled with the help-wanted or bug labels. If the issue you want to work on is not labelled with help-wanted or bug, you can start a conversation with the project owner asking whether an external contribution will be considered.

To avoid multiple pull requests resolving the same issue, let others know you are working on it by saying so in a comment.

Contributing to translations

If you want to help us to translate this extension into other languages, please read this article

Note that whatever you want to contribute to the codebase, you should do it only after you got assigned on an issue

Submitting pull requests

To enable us to quickly review and accept your pull requests, always create one pull request per issue and link the issue in the pull request. Never merge multiple requests in one unless they have the same root cause. Be sure to follow our Coding Guidelines and keep code changes as small as possible. Avoid pure formatting changes to code that has not been modified otherwise. Pull requests should contain tests whenever possible. Fill pull request content according to its template. Deviations from template are not recommended

Spell check errors

Pull requests that fix typos are welcomed but please make sure it doesn't touch multiple feature areas, otherwise it will be difficult to review. Pull requests only fixing spell check errors in source code are not recommended.

Thank You!

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to contribute.

Attribution

These Contribution Guidelines are adapted from the Contributing to VS Code