Skip to content

Latest commit

聽

History

History
105 lines (64 loc) 路 4.06 KB

CONTRIBUTING.md

File metadata and controls

105 lines (64 loc) 路 4.06 KB
Raw

How to contribute

It is a paramount to the development of proxier that the community is empowered to make changes and get them into the library. Here are some guidelines for making a cake walk through this process.

Reporting issues

To report a bug, request a feature, or even ask a question, make use of the GitHub Issues section for proxier. When submitting an issue please take the following steps:

  1. Seach for existing issues. Your question or bug may have already been answered or fixed, be sure to search the issues first before putting in a duplicate issue.

  2. Create an isolated and reproducible test case. If you are reporting a bug, make sure you also have a minimal, runnable, code example that reproduces the problem you have.

  3. Include a live example. After narrowing your code down to only the problem areas, make use of repl.it or a link to your live site so that we can view a live example of the problem.

  4. Share as much information as possible. Include browser version affected, your OS, version of the library, steps to reproduce, etc. "X isn't working!!!1!" will probably just be closed.

Contributing Changes

Setting Up

To setup for making changes you will need to take a few steps, we've outlined them below:

  1. Ensure you have node and npm installed.

  2. Fork the proxier repository, if you are unsure how to do this GitHub has a guides for the command line and for the GitHub Client.

  3. Next, run npm install from within the clone of your fork. That will install all dependencies necessary to build proxier.

Making a Change

Once you have the repository on your machine and have installed dependencies you are almost ready to make your change(s). The only other thing to do before you start is to checkout to the correct branch. Which branch you should make your change to (and send a PR to) depends on the type of change you are making.

Always make your change to develop as it is the branch for QA testing and feature compilation before pushing to master.

Your change should be made directly to the branch in your fork, or to a branch in your fork made off of one of the above branches.

Branch Naming

Branches created should be named using the following format:

{type}-{2-3 word summary separated with hyphen}

Type:

  • feature
  • bug
  • chore
  • refactor

Example:

refactor-data

PR Description Template

The description of the PR should contain the following headings and corresponding content in Markdown format.

#### What does this PR do?
#### Description of Task to be completed?
#### How should this be manually tested?
#### Any background context you want to provide?
#### Screenshots (if appropriate)

Testing Your Change

You can run these tests by running npm run test from the command line. If you fix a bug please add a test that will catch that bug if it ever happens again. This prevents regressions from sneaking in.

Submitting Your Change

After you have made and tested your change, commit and push it to your fork. Then, open a Pull Request from your fork to the main proxier repository on the branch you used in the Making a Change section of this document.

Quickie Code Style Guide

proxier adheres stricty to the eslint airbnb style guide. Read below for a quickie style guide:

  • Rely heavily on ES5 style of writing code.
  • Indentation of two spaces

Support

proxier supports node.js. Bear in mind this when altering and/or extending the sources.

Important

  • Please make sure that you run tests before making a PR.

Contributor Code of Conduct

Code of Conduct is adapted from Contributor Covenant, version 2.0