Skip to content

Commit bf9b7ff

Browse files
authored
docs: add CONTRIBUTING.md
1 parent 093cfec commit bf9b7ff

File tree

2 files changed

+45
-0
lines changed

2 files changed

+45
-0
lines changed

CONTRIBUTING.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Contributing to semantic-release-jira-notes
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
12+
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:
13+
14+
1. Fork the repo and create your branch from `main`.
15+
2. If you've added code that should be tested, add tests.
16+
3. If you've changed APIs, update the documentation.
17+
4. Ensure the test suite passes.
18+
5. Make sure your code lints with [Prettier](https://prettier.io/).
19+
6. Issue that pull request!
20+
21+
## Report bugs using Github's [issues](https://github.com/briandk/transcriptase-atom/issues)
22+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](); it's that easy!
23+
24+
## Write bug reports with detail, background, and sample code
25+
26+
Great Bug Reports tend to have:
27+
28+
- A quick summary or background
29+
- Steps to reproduce
30+
- Be specific!
31+
- Give sample code if you can.
32+
- What you expected would happen
33+
- What actually happens
34+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
35+
36+
People *love* thorough bug reports.
37+
38+
## Use a Consistent Coding Style
39+
40+
We use [Prettier](https://prettier.io/) to format code consistently. Please make sure you install the extension on your IDE
41+
to make sure the rules defined in [.prettierrc.json](./.prettierrc.json) are respected.

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -97,3 +97,7 @@ You can also use options defined by [@semantic-release/release-notes-generator](
9797
]
9898
}
9999
```
100+
101+
## Contributing
102+
103+
You are welcome to contribute to this repository. Please refer to [CONTRIBUTING.md](./CONTRIBUTING.md) for more information.

0 commit comments

Comments
 (0)