Skip to content

Latest commit

 

History

History
61 lines (43 loc) · 2.99 KB

CONTRIBUTING.md

File metadata and controls

61 lines (43 loc) · 2.99 KB
Raw

🚀 I want contribute

There is surely nothing other than the single purpose of the present moment. A man's whole life is a succession of moment after moment. There will be nothing else to do, and nothing else to pursue. Live being true to the single purpose of the moment.

(c) Yamamoto Tsunetomo "Hagakure"

That's awesome 👏! Check out good first issues, most likely you can do some contribution using web interface, otherwise worry not 😏.

Make fork of a repo, clone it and run:

cd putout
npm install
npm run bootstrap

No matter what package you are interested in, you always have 4 little friends:

  • 🦊 lint
  • 🐺 fix:lint
  • 🦏 test
  • 🦛 coverage

You can call them from each package with npm run and they will always come 🤙.

🤷 How to check if my changes do not break anything?

When your made changes, added coverage and your package is ready for publishing 📦 , run: npm run fresh, in the root of the repository, it will run lint and test over all packages.

🤷 What if I'm adding new plugin?

When adding new plugin, add it to package.json and putout.json. Update Built-in Transformations and Plugins.

🤷 How to name commit?

Format of the commit message: type: scope: subject

Type:

Scope: Scope could be anything specifying place of the commit change. For example @putout/plugin-remove-unused-variables, @putout/cli-ruler, putout etc...

Subject text:

  • use imperative, present tense: “change” not “changed” nor “changes”
  • don't capitalize first letter
  • no dot (.) at the end Message body:
  • just as in use imperative, present tense: “change” not “changed” nor “changes”
  • includes motivation for the change and contrasts with previous