Skip to content

Latest commit

 

History

History
82 lines (60 loc) · 2.87 KB

CONTRIBUTING.md

File metadata and controls

82 lines (60 loc) · 2.87 KB

Contributing

Local Development

You can use the examples folder for local development. To do so, run the following:

npm install
npm link
cd example
npm install
npm link redux-injectors
rm -rf node_modules/react
rm -rf node_modules/react-dom
rm -rf node_modules/react-redux

npm start

Pull requests

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, porting to a different language), 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).

Please target the master branch with pull requests.

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 https://github.com/<your-username>/redux-injectors.git
# Navigate to the newly cloned directory
cd redux-injectors
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/react-boilerplate/redux-injectors.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 master branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Commit your changes in logical chunks. Please adhere to these git commit message guidelines or your code is unlikely be merged into the main project. Use Git's interactive rebase feature to tidy up your commits before making them public.

  5. Locally merge (or rebase) the upstream master branch into your topic branch:

    git pull [--rebase] upstream master

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

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

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

Tips

  • When changing the API, including the jsdoc comments, please remember to update the typings file: index.d.ts