First of all, thanks for thinking of contributing to this project! 👏
Following these guidelines helps to communicate that you respect the time of the maintainer and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
This project has a Contributor Covenant Code of Conduct. By participating in this project you agree to abide by its terms.
- 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.
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.
In case you've encountered a bug, please make sure:
- You have read the documentation first, and double-checked your configuration.
- 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 from a verbose and/or debug run.
- All steps to reproduce the issue.
Pull requests are welcome! If you never created a pull request before, here are some tutorials:
Please keep the following in mind:
- 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.