You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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).
12
20
@@ -19,34 +27,50 @@ If you want some code examples for how to write watchers or other types of clien
19
27
20
28
There are many ways to contribute to ActivityWatch:
21
29
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.
26
37
- 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.
31
38
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
Thanks for wanting to help out with squashing bugs and more by filing an issue.
38
55
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).
40
73
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:
@@ -77,4 +101,12 @@ This guideline was adopted in [issue #391](https://github.com/ActivityWatch/acti
77
101
78
102
## Questions?
79
103
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)
0 commit comments