Skip to content

Commit c80dce7

Browse files
committed
chore: add CONTRIBUTING.md
1 parent a351e22 commit c80dce7

File tree

2 files changed

+80
-0
lines changed

2 files changed

+80
-0
lines changed

CONTRIBUTING.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributing
2+
3+
Thank you for showing interest in contributing to GlanceThing! This document will lay out some of the policies, processes and expectations for contributing to the project.
4+
5+
## Code of Conduct
6+
7+
Please be respectful and constructive when interacting with others.
8+
9+
Harassment, personal attacks, or disrespectful behavior will not be tolerated.
10+
Assume good intentions and focus discussions on improving the project.
11+
12+
## How To Contribute
13+
14+
0. Make a fork of the repository and clone it locally
15+
1. Create a new branch:
16+
```bash
17+
git checkout -b my-awesome-feature
18+
```
19+
2. Start making your changes
20+
3. Make sure you run the following commands to verify the code builds, and to follow formatting and code style rules:
21+
22+
```bash
23+
# in the root of the repository
24+
npm run build
25+
npm run lint
26+
npm run format
27+
28+
# in /client
29+
npm run build
30+
npm run lint
31+
```
32+
33+
Installing Prettier and ESLint in your IDE can help automate this!
34+
35+
4. Commit your changes (following [Conventional Commits](https://conventionalcommits.org))
36+
5. Push your changes
37+
6. Make a pull request (style explained below)
38+
39+
## Making Pull Requests
40+
41+
Pull requests should:
42+
43+
- Focus on one or few changes at a time (massive pull reqeusts will be denied)
44+
- Clearly describe its changes
45+
46+
Pull request titles should also follow [Conventional Commits](https://conventionalcommits.org), e.g.:
47+
48+
```
49+
fix: prevent crash when configuration for X is missing
50+
```
51+
52+
## AI Policy
53+
54+
AI Tools (GitHub Copilot, Cursor, Claude, etc.) can be used for assistance when developing, but the human developer must understand and is responsible for the changes.
55+
56+
Using AI for research, suggestions, boilerplate/examples and autocompletion may be allowed.
57+
58+
Any AI used to make changes to the project must be disclosed in the pull request.
59+
60+
Automated changes and pull requests (e.g. OpenClaw) is disallowed.
61+
62+
Maintainers hold the right to close pull requests and deny changes that are suspected of using automated AI tools, or where the developer cannot explain what the changes contain.
63+
64+
## Maintainer Rights
65+
66+
The maintainer(s) holds the right to do the following:
67+
68+
- Request / push changes to a pull request before it is merged
69+
- Reject pull requests that are low-quality, automated or do not align with the project's goals
70+
- Close stale pull requests and issues
71+
72+
## Closing Thoughts
73+
74+
These guidelines help keep the project maintainable, and creates a sustainable environment for everyone looking to help the development of the project.
75+
76+
Thanks again for showing interest in helping the project!

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,10 @@ GlanceThing will for the most part live in your system tray. Right-click it to b
7878

7979
<img src=".github/assets/tray.png" />
8080

81+
## Contributing
82+
83+
Contributions are very welcome! Make sure to follow the guidelines laid out in [CONTRIBUTING.md](CONTRIBUTING.md).
84+
8185
## Support
8286

8387
If you need any help with GlanceThing or the CarThing in general, don't hesitate to ask! You can either submit issues here, join [my discord server](https://discord.bludood.com) or join the [Thing Labs discord server](https://discord.gg/car-thing-hax-community-1042954149786046604).

0 commit comments

Comments
 (0)