Skip to content

Latest commit

 

History

History
98 lines (70 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

98 lines (70 loc) · 2.85 KB
Raw

Contributing to Kuroshiro

All kinds of contributions are welcome, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Submitting new analyzer plugins or fixes of them
  • Proposing new features
  • Help translating the documents

Code Organization

Files Description
src/*.js core files
dist/*.js generated UMD distribution
lib/*.js generated CommonJS distribution
test/*.js test files

Setting up development environment

To contribute, fork the library and install dependencies. You need git and node; you might use nvm

git clone https://github.com/<your-username>/kuroshiro
npm install
npm run test

Pull Request Process

Before Submitting

  • Pull requests to the master branch will be closed. Please submit all pull requests to the dev branch.
  • DO NOT submit changes to the generated files. Instead only change src/*.js and run the tests.

Pull request - Submission

  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>/kuroshiro
# Navigate to the newly cloned directory
cd kuroshiro
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/hexenq/kuroshiro

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

    git checkout <your-dev-branch>
git pull upstream dev

  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. Make sure the tests are robust and passed. And refine the documents if needed.

  5. Commit your changes in logical chunks. Use Git's interactive rebase feature to tidy up your commits before making them public.

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

    git pull [--rebase] upstream dev

  7. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  8. Open a Pull Request to dev branch with a clear title and description.

Code Style

This repository uses eslint to maintain code style and consistency. airbnb-base and some additional rules are used as a guideline.

How to submit new analyzer plugins

There is a sample/seed repository kuroshiro-analyzer-seed for you. Check it out.

License

By contributing, you agree that your contributions will be licensed under MIT License.