Skip to content

Latest commit

 

History

History
113 lines (71 loc) · 3.57 KB

CONTRIBUTING.md

File metadata and controls

113 lines (71 loc) · 3.57 KB
Raw

RE:DOM Contributing Guide

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

Setting up your development environment

You'll need a recent version of Node to work this project.

Once node is installed, simply clone our repository (or your fork of it) and run yarn install or npm install

  $ git clone git@github.com:redom/redom.git
  $ cd redom
  $ yarn install

Running development server

  $ yarn run dev # Listen changes and RE:DOM.

This should aid you in initial development of a component. It's served on port 8080.

Building

  $ yarn run build

Linting / Testing

  $ yarn run lint
  $ yarn run test

Feature requests

Feature requests are welcome, but please 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.

To get approval for your feature request, please create an issue on the issue tracker with as much detail and context as possible.

Reporting Bugs

A bug is a demonstrable, reproducible problem that is caused by the code in the repository. Good bug reports are extremely helpful, so thanks!

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 develop branch in the repository.
  3. Isolate the problem - you should provide a live example — ideally also create a reduced test case.

This CodePen, JSFiddle are helpful templates you can fork or clone.

Submitting Pull requests

Good pull requests are an amazing help.

They should remain focused in scope and avoid containing unrelated commits.

Adhering to the following process is the best way to get your work included in the project:

Fork the project, clone your fork, and configure the remotes:

  $ git clone https://github.com/<your-username>/redom.git
  $ cd redom
  $ git remote add upstream https://github.com/redom/redom.git

If you cloned a while ago, get the latest changes from upstream:

  $ git checkout develop
  $ git pull [--rebase] upstream develop

Create a new topic branch (off the main project develop branch) to contain your feature, change, or fix:

  git checkout -b <topic-branch-name>

Commit your changes in logical chunks. Please adhere to these guidelines.

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 develop

Push your topic branch up to your fork:

  $ git push origin <topic-branch-name>

Open a Pull Request with a clear title and description against the develop branch.

By submitting a patch, you agree to allow the project owner to license your work under the terms of the MIT License.

Credits

Thank you to all the people who have already contributed to RE:DOM!