Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 2.78 KB
Raw

Contribution Guidelines

First of all, thanks for thinking of contributing to this project! 👏

This project has a Contributor Covenant Code of Conduct. By participating in this project you agree to abide by its terms.

❤️ Ways to Contribute

  • Blog or tweet about the project
  • Improve documentation
  • Fix a bug
  • Implement a new feature
  • Discuss potential ways to improve project
  • Improve existing implementation, performance, etc.

🛎 Questions & Feature Requests

Feel free to open a ticket with your question. Feature requests are also welcome. Describe the feature, why you need it, and how it should work. Please provide as much detail and context as possible.

🐛 File a Bug

In case you've encountered a bug, please make sure:

  • You are using the latest version.
  • You have read the documentation first, and double-checked your configuration.
  • You have acknowledged from using --verbose and --debug the errors are likely a bug in this project, and not coming from e.g. your environment or custom scripts/commands.
  • In your issue description, please include: _ What you expected to see, and what happened instead. _ Your operating system and other environment information. _ As much information as possible, such as the command and configuration used. _ Interesting logs with --verbose and/or --debug. * All steps to reproduce the issue.

🎁 Pull Requests

Pull requests are welcome! If you never created a pull request before, here are some tutorials:

Please keep the following in mind:

  • To match the existing code styling, use npm run format before committing code.
  • Make sure the tests pass (run npm test). Your changes probably deserve new tests as well.
  • Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different versions of Node.

Unsure about whether you should open a pull request? Feel free to discuss it first in a ticket.

Fork the repository, and set it up on your machine:

git clone https://github.com/<your-github-username>/release-it
cd release-it
npm install

Verify the tests are passing:

npm test

To use your modified version of release-it in your project, npm-link it:

# From your release-it clone:
npm link

# From your project that uses release-it:
npm link release-it