Skip to content

Commit 281c24c

Browse files
committed
add CONTRIBUTING file
1 parent 9849bd2 commit 281c24c

File tree

2 files changed

+60
-1
lines changed

2 files changed

+60
-1
lines changed

CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines
2+
3+
Thank you for your interest in contributing to onefetch! Whether it's a bug report, new feature, correction, or additional
4+
documentation, we greatly value feedback and contributions from our community.
5+
6+
Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7+
information to effectively respond to your bug report or contribution.
8+
9+
## Reporting Bugs/Feature Requests
10+
11+
We welcome you to use the GitHub issue tracker to report bugs or suggest features.
12+
13+
When filing an issue, please check [existing open](https://github.com/o2sh/onefetch/issues), or [recently closed](https://github.com/o2sh/onefetch/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
14+
reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
15+
16+
* A reproducible test case or series of steps
17+
* The version of our code being used
18+
* Any modifications you've made relevant to the bug
19+
* Anything unusual about your environment or deployment
20+
21+
## Contributing via Pull Requests
22+
23+
Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
24+
25+
1. You are working against the latest source on the *master* branch.
26+
2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
27+
3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
28+
29+
To send us a pull request, please:
30+
31+
1. Fork the repository.
32+
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
33+
3. Ensure local tests pass.
34+
4. Commit to your fork using clear commit messages.
35+
5. Send us a pull request, answering any default questions in the pull request interface.
36+
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
37+
38+
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
39+
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
40+
41+
### Project-specific notes
42+
43+
- Please ensure your changes are formatted according to `cargo fmt`.
44+
- Do check for linting errors with `cargo clippy`. If you're having trouble with this, feel free to ask for help.
45+
- Documenting your changes in `CHANGELOG.md` (in the Unreleased section) would be awesome, but is not required.
46+
- If you can, try to write some tests for your change (if it addresses a bug) or feature. Again, feel free to ask for help. Our CI will run these tests to ensure your code never breaks with future changes.
47+
48+
## Finding contributions to work on
49+
50+
Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/o2sh/onefetch/labels/help%20wanted) issues is a great place to start.
51+
52+
## Code of Conduct
53+
54+
This project has adopted the Contributor Covenant Code of Conduct, version 2.0. It can be found in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md). Contributors and community members are expected to adhere to this code of conduct to create a welcoming environment.
55+
56+
## Licensing
57+
58+
See the [LICENSE](https://github.com/o2sh/onefetch/blob/master/LICENSE) file for our project's licensing. We will ask you confirm the licensing of your contribution.
59+

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,6 @@ You can further configure Onefetch to display exactly what you want it to. Throu
2727

2828
Onefetch supports almost 50 different programming languages. If your language of choice isn't supported: Open up an issue and support will be added.
2929

30-
Contributions are very welcome! See CONTRIBUTING for more info.
30+
Contributions are very welcome! See [CONTRIBUTING](https://github.com/o2sh/onefetch/blob/master/LICENSE) for more info.
3131

3232
### More: \[[Installation](https://github.com/o2sh/onefetch/wiki/Installation)\] \[[Getting Started](https://github.com/o2sh/onefetch/wiki/getting-started)\] \[[Wiki](https://github.com/o2sh/onefetch/wiki)\]

0 commit comments

Comments
 (0)