Skip to content

Latest commit

History

History
47 lines (27 loc) 路 1.17 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) 路 1.17 KB

Contributing

We love pull requests from everyone. By participating in this project, you agree to abide by the project's code of conduct.

Fork, then clone the repo:

git clone git@github.com:<your-username>/giveaway-grabber.git;

Set up your machine:

Install Node.js (>=10.0.0), npm version 3+. Then install dependencies:

npm install

Make your change

You can run the script locally with npm start. Note that options must be passed with an extra --, like:

npm start -- --page=34

Add tests for your change, if possible.

Make sure the tests pass:

npm test

Lint your code:

  npm run lint

Push to your fork and submit a pull request.

At this point you're waiting on us. We may suggest some changes or improvements or alternatives.

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

  • Write tests.
  • Write a description in the pull request explaining why you did what you did.
  • Write a good commit message.