Skip to content

Latest commit

 

History

History
121 lines (84 loc) · 2.64 KB

CONTRIBUTING.md

File metadata and controls

121 lines (84 loc) · 2.64 KB
Raw

Contributing

From opening a bug report to creating a pull request: every contribution is appreciated and welcome. If you're planning to implement a new feature or change an existing one, please create an issue first. This way we can ensure that your precious work is not in vain.

Issues

If you have discovered a bug or have a feature suggestion, feel free to create an issue on Github.

Submitting Changes

Strategy

  1. generate a nikita project from a local checkout of generator-nikita
  2. work on that generated project and commit all the changes locally
  3. backport the changes to the checkout of generator-nikita
  4. generate the project again.
  5. if no files are modified and test are passing your done

Setup

  1. fork generator-nikita on Github

  2. clone your fork

git clone git@github.com:<YOUR-USER>/generator-nikita.git
  1. make a new branch and set upstream
cd generator-nikita
git checkout -b myfeature
git remote add upstream git@github.com:nikita-kit/generator-nikita.git
  1. install npm and make sure that all tests passing
npm install
npm test
  1. generate a nikita project with the forked generator (yeoman needs to be installed: npm install yo -g)
cd ..
mkdir nikita-generated
cd nikita-generated
yo ../generator-nikita

  1. answer the questions in a reasonable way for your feature or fix

  2. commit the generated folder to a local git repo

git init
git add .
git commit -m"initial commit"
  1. make your changes (don't forget the readme), run grunt for testing and commit all
grunt
git commit -m"added my feature"
  1. backport your changes to generator checkout at generator-nikita folder
cd ../generator-nikita
  1. rerun the generator at the nikita-generated folder
cd ../nikita-generated
yo ../generator-nikita

  1. answer all questions by hitting enter

  2. if nothing is modified, you're nearly done

git diff
  1. run the tests at generator-nikita folder and update the changelog
cd ../generator-nikita
npm run test
  1. if all tests are passing, commit your changes and push them
git add <YOUR-CHANGES>
git commit -m"added my feature"
git push

Create Pull Request

After getting some feedback, push to your fork and submit a pull request. We may suggest some changes or improvements or alternatives, but for small changes your pull request should be accepted quickly.

Some things that will increase the chance that your pull request is accepted:

  • update Readme and Changelog
  • write tests
  • follow the existing coding style
  • Write a good commit message