Skip to content

Commit 9277301

Browse files
committed
docs(CONTRIBUTING): improved contributing guide
1 parent 3343130 commit 9277301

1 file changed

Lines changed: 55 additions & 23 deletions

File tree

CONTRIBUTING.md

Lines changed: 55 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,20 @@
11
How to Contribute
22
=================
33

4-
**Did you come here to read what you should do before creating an issue?** Scroll down!
4+
<!-- This guide could be improved by following the advice at https://mozillascience.github.io/working-open-workshop/contributing/ -->
55

6-
**Note:** This is a work in progress, there is a lot we could do better so file a PR if you think we've missed something!
6+
**Table of Contents**
77

8+
- [Getting started](#getting-started)
9+
- [How you can help](#how-you-can-help)
10+
- [Filing an issue](#filing-an-issue)
11+
- [Getting paid](#getting-paid)
12+
- [Code of Conduct](#code-of-conduct)
13+
- [Commit message guidelines](#commit-message-guidelines)
14+
- [Questions?](#questions)
815

9-
## Getting started with development
16+
17+
## Getting started
1018

1119
To develop on ActivityWatch you'll first want to install from source. To do so, follow [the guide in the documentation](https://activitywatch.readthedocs.io/en/latest/installing-from-source.html).
1220

@@ -19,34 +27,50 @@ If you want some code examples for how to write watchers or other types of clien
1927

2028
There are many ways to contribute to ActivityWatch:
2129

22-
- Help with testing by being an early user and reporting bugs.
23-
- Help with one of the issues labeled [`help wanted`](https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22), these are especially suited for new contributors.
24-
- Help write documentation.
25-
- Help build the ecosystem.
30+
- Work on issues labeled [`good first issue`][good first issue] or [`help wanted`][help wanted], these are especially suited for new contributors.
31+
- Fix [`bugs`][bugs].
32+
- Implement new features.
33+
- Look among the [requested features][requested features] on the forum.
34+
- Talk to us in the issues or on [our Discord server][discord] to get help on how to proceed.
35+
- Write documentation.
36+
- Build the ecosystem.
2637
- Examples: New watchers, tools to analyze data, tools to import data from other sources, etc.
27-
- Help fix bugs.
28-
- See the issues in this repo.
29-
- Help implement new features.
30-
- Want to start working on a new feature? Find the appropriate subrepo, if any, and see if there is anything that needs doing.
3138

32-
Most of the above will get you up on our [contributor stats page](http://activitywatch.net/contributors/) as thanks!
39+
If you're interested in what's next for ActivityWatch, have a look at our [roadmap][roadmap] and [milestones][milestones].
40+
41+
Most of the above will get you up on our [contributor stats page][contributors] as thanks!
42+
43+
[good first issue]: https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22
44+
[help wanted]: https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22
45+
[bugs]: https://github.com/ActivityWatch/activitywatch/issues?q=is%3Aissue+is%3Aopen+label%3A%22bugs%22
46+
[milestones]: https://github.com/ActivityWatch/activitywatch/milestones
47+
[roadmap]: https://github.com/orgs/ActivityWatch/projects/2
48+
[requested features]: https://forum.activitywatch.net/c/features
49+
[contributors]: http://activitywatch.net/contributors/
3350

3451

3552
## Filing an issue
3653

3754
Thanks for wanting to help out with squashing bugs and more by filing an issue.
3855

39-
There are a few things you might consider when filing your issue:
56+
When filing an issue, it's important to use an [issue template](https://github.com/ActivityWatch/activitywatch/issues/new/choose). This ensures that we have the information we need to understand the issue, so we don't have to ask for tons of follow-up questions, so we can fix the issue faster!
57+
58+
59+
## Getting paid
60+
61+
We're experimenting with paying our contributors using funds we've raised from donations and grants.
62+
63+
The idea is you track your work with ActivityWatch (and ensure it gets categorized correctly), then you modify the [working_hours.py](https://github.com/ActivityWatch/aw-client/blob/master/examples/working_hours.py) script to use your category rule and generate a report of time worked per day and the matching events.
64+
65+
If you've contributed to ActivityWatch (for a minimum of 10h) and want to get paid for your time, contact us!
66+
67+
You can read more about this experiment on [the forum](https://forum.activitywatch.net/t/getting-paid-with-activitywatch/986) and in [the issues](https://github.com/ActivityWatch/activitywatch/issues/458).
68+
69+
70+
## Code of Conduct
71+
72+
We have a Code of Conduct that we expect all contributors to follow, you can find it in [`CODE_OF_CONDUCT.md`](./CODE_OF_CONDUCT.md).
4073

41-
- Which version of ActivityWatch are you running?
42-
- NOTE: There is currently no good way to find this out, sorry about that.
43-
- What made the issue/bug appear? (steps to reproduce)
44-
- Include a logfile
45-
- Log files can be found in different places, depending on platform:
46-
- macOS: `~/Library/Logs/activitywatch`
47-
- Linux: `~/.cache/activitywatch/log`
48-
- Windows: `C:\Users\<USERNAME>\AppData\Local\activitywatch\activitywatch\Logs`
49-
5074

5175
## Commit message guidelines
5276

@@ -77,4 +101,12 @@ This guideline was adopted in [issue #391](https://github.com/ActivityWatch/acti
77101

78102
## Questions?
79103

80-
If you have any questions, post on [the forum](https://forum.activitywatch.net/) or email one of the maintainers at: [erik@bjareho.lt](mailto:erik@bjareho.lt).
104+
If you have any questions, you can:
105+
106+
- Talk to us on our [Discord server][discord]
107+
- Post on [the forum][forum] or [GitHub Discussions][github discussions].
108+
- (as a last resort/if needed) Email one of the maintainers at: [erik@bjareho.lt](mailto:erik@bjareho.lt)
109+
110+
[forum]: https://forum.activitywatch.net
111+
[github discussions]: https://github.com/ActivityWatch/activitywatch/discussions
112+
[discord]: https://discord.gg/vDskV9q

0 commit comments

Comments
 (0)