@davidspekorg/semantic-release-jira-notes
Version:
Semantic Release plugin to add JIRA issues link to the release notes
42 lines (30 loc) • 1.74 kB
Markdown
# Contributing to semantic-release-jira-notes
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
1. Fork the repo and create your branch from `main`.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints with [Prettier](https://prettier.io/).
6. Issue that pull request!
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
## Write bug reports with detail, background, and sample code
Great Bug Reports tend to have:
- A quick summary or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
People *love* thorough bug reports.
## Use a Consistent Coding Style
We use [Prettier](https://prettier.io/) to format code consistently. Please make sure you install the extension on your IDE
to make sure the rules defined in [.prettierrc.json](./.prettierrc.json) are respected.