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
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+14-7
Original file line number
Diff line number
Diff line change
@@ -16,8 +16,8 @@ Contributions can take many forms, and all are very welcome:
16
16
Bugs are annoying for everyone, so please help us identify and fix the bug by providing a good bug report.
17
17
18
18
**What is a good Bug Report?**
19
-
A good bug report should contain the expected behavior, the observed behavior and all the necessary actions you took.
20
-
Ideally, it should be reproducible but we understand that this is not always possible. Please make sure to follow these
19
+
A good bug report should contain the expected behavior, the observed behavior, and all the necessary actions you took.
20
+
Ideally, it should be reproducible, but we understand that this is not always possible. Please make sure to follow these
21
21
steps before submitting a bug report:
22
22
23
23
- Check the [Issues Page](https://github.com/tira-io/tira/issues) if others have reported similar problems (also make
@@ -36,7 +36,7 @@ your issue. You can report a bug using GitHub Issues as follows:
36
36
4.**Make sure you do NOT leak any confidential data (e.g., API Keys or Secrets) on accident!**
37
37
38
38
## Reporting Vulnerabilities
39
-
Vulnerabilities should not publicly be disclosed until they are fixed. Please have a look at our
39
+
Vulnerabilities should not be publicly disclosed until they are fixed. Please take a look at our
40
40
[Security Policy](SECURITY.md) for more information.
41
41
42
42
## Suggesting Enhancements and new Features
@@ -45,16 +45,23 @@ Please open an [Enhancement Issue](https://github.com/tira-io/tira/issues/new?as
45
45
and make sure to cover the following points to give your idea the best chance of being implemented:
46
46
47
47
-**Clearly and concisely** describe the idea behind the enhancement or feature. The more people have to read, the less
48
-
they are motivated to read your entire proposal and the less likely they are to support it.
49
-
- Now that you got people hooked, you can be more elaborate: how (if at all) can the goal be achieved now? How do you
48
+
they are motivated to read your entire proposal, and the less likely they are to support it.
49
+
- Now that you have people hooked, you can be more elaborate: how (if at all) can the goal be achieved now? How do you
50
50
envision it to work if your feature request or enhancement is implemented?
51
51
- A picture is worth a thousand words — you may add pictures to show what you envision. This is, of course, not
52
52
required.
53
53
54
54
## Contributing Code
55
-
TODO
55
+
Code contributions can take many forms... from minor bug fixes, to bigger patches to entirely new features but they are
56
+
worth nothing if the code is unreadable, unmaintainable or does not fit into TIRAs architecture. If you consider
57
+
contributing code, please have a look at our [Code Guidelines](https://tira-io.github.io/tira/development/contributing/guidelines.html)
58
+
and read our [Documentation for Developers](https://tira-io.github.io/tira/development/index.html). We are very happy
59
+
about all code contributions and features and with these rules we want to ensure that they can be part of TIRAs future
60
+
even when the original developer has left TIRAs development.
56
61
57
62
## Improving the Documentation
58
63
Documentation is *PART OF* the software and not a second class citizen. Good documentation simplifies the onboarding
59
64
process of new programmers and new users. Generally, the same guidelines apply as for
60
-
[contributing code](#contributing-code).
65
+
[contributing code](#contributing-code). If you feel like some parts of the documentation are out-of-date or not clear,
66
+
feel free to create a [Documentation Issue](https://github.com/tira-io/tira/issues/new?assignees=&labels=documentation&projects=&template=50-documentation-issue.md)
67
+
after you made sure that the same issue did not exist previously (open or closed).
0 commit comments