Skip to content

Commit ce1bdf8

Browse files
committed
refactor: update contributing guidelines
1 parent 104cbad commit ce1bdf8

File tree

3 files changed

+61
-94
lines changed

3 files changed

+61
-94
lines changed

CONTRIBUTING.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Contributing to tmux-notify
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 Develop with Github
12+
13+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
14+
15+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
16+
17+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow)). We actively welcome your pull requests:
18+
19+
1. Fork the repo and create your branch from `master`.
20+
2. If you've added code that should be tested, add tests.
21+
3. If you've changed APIs, update the documentation.
22+
4. Ensure the test suite passes.
23+
5. Make sure your code lints.
24+
6. Issue that pull request!
25+
26+
## Any contributions you make will be under the MIT Software License
27+
28+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
29+
30+
## Report bugs using Github's [issues](https://github.com/rickstaa/tmux-notify/issues)
31+
32+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/rickstaa/tmux-notify/issues/new/choose); it's that easy!
33+
34+
## Write bug reports with detail, background, and sample code
35+
36+
[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
37+
38+
**Great Bug Reports** tend to have:
39+
40+
- A quick summary and/or background
41+
- Steps to reproduce
42+
- Be specific!
43+
- Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that _anyone_ with a base R setup can run to reproduce what I was seeing
44+
- What you expected would happen
45+
- What actually happens
46+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
47+
48+
People _love_ thorough bug reports. I'm not even kidding.
49+
50+
## Use a Consistent Coding Style
51+
52+
We use [shfmt](https://github.com/mvdan/sh#shfmt) to format our shell scripts. The easiest way to use [shfmt](https://github.com/mvdan/sh#shfmt) is through the [bash-beautify](https://marketplace.visualstudio.com/items?itemName=shakram02.bash-beautify) or [shell-format](https://marketplace.visualstudio.com/items?itemName=foxundermoon.shell-format) VS Code extensions.
53+
54+
## License
55+
56+
By contributing, you agree that your contributions will be licensed under its MIT License.
57+
58+
## References
59+
60+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md).

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ Will add other prompt end characters as needed.
7575

7676
## Contributing
7777

78-
Contributions to this repository are welcome. See the [contribution guidelines](contributing.md) for more information.
78+
Feel free to open an issue if you have ideas on how to make this GitHub action better or if you want to report a bug! All contributions are welcome. :rocket: Please consult the [contribution guidelines](CONTRIBUTING.md) for more information.
7979

8080
## License
8181

contributing.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

0 commit comments

Comments
 (0)