Skip to content

Latest commit

 

History

History
62 lines (40 loc) · 2.14 KB

CONTRIBUTING.md

File metadata and controls

62 lines (40 loc) · 2.14 KB
Raw

Contributing to Conflux

When contributing to this repository, please first discuss the change you wish to make via issue, email, Slack, LinkedIn, or any other method with Dustin Myers or Nathan Thomas before making a change.

Please note we have a Code of Conduct. Please follow it in all your interactions with the project.

Using the Issue Tracker

The issue tracker is the preferred channel for spelling mistakes, errors or any general smaller feedback. Please respect the following restriction:

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

Pull Requests

Please adhere to the coding conventions used throughout the project (spelling, indentation, punctuation etc.).

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

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

    # Clone your fork of the repo into the current directory
git clone git@github.com/<your-username>/react-conflux.git

# Navigate to the newly cloned directory
cd react-conflux/

# Assign the original repo to a remote called "upstream"
git remote add upstream git@github.com:dustinmyers/react-conflux.git

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

    git checkout master
git pull upstream master

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

    git checkout -b <topic-branch-name>

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

    git pull [--rebase] upstream master

  5. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  6. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting patches, you agree to allow the project owners to license your work under the terms of the MIT License.