Skip to content

Commit 0603333

Browse files
committed
Updated contribution guidelines
1 parent c25db88 commit 0603333

File tree

5 files changed

+32
-19
lines changed

5 files changed

+32
-19
lines changed

CONTRIBUTING.md

+14-7
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@ Contributions can take many forms, and all are very welcome:
1616
Bugs are annoying for everyone, so please help us identify and fix the bug by providing a good bug report.
1717

1818
**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
2121
steps before submitting a bug report:
2222

2323
- 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:
3636
4. **Make sure you do NOT leak any confidential data (e.g., API Keys or Secrets) on accident!**
3737

3838
## 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
4040
[Security Policy](SECURITY.md) for more information.
4141

4242
## Suggesting Enhancements and new Features
@@ -45,16 +45,23 @@ Please open an [Enhancement Issue](https://github.com/tira-io/tira/issues/new?as
4545
and make sure to cover the following points to give your idea the best chance of being implemented:
4646

4747
- **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
5050
envision it to work if your feature request or enhancement is implemented?
5151
- A picture is worth a thousand words — you may add pictures to show what you envision. This is, of course, not
5252
required.
5353

5454
## 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.
5661

5762
## Improving the Documentation
5863
Documentation is *PART OF* the software and not a second class citizen. Good documentation simplifies the onboarding
5964
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).
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Contribution Guidelines
1+
Code Guidelines
22
=======================
33

4-
.. include:: ../../../../CONTRIBUTING.md
4+
.. todo:: Add code guidelines
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
Contributing
2-
============
3-
.. todo:: add a nice introductory text and thank for the interest in helping out for further TIRA
2+
=======================
3+
4+
.. include:: ../../../../CONTRIBUTING.md
5+
:parser: myst_parser.sphinx_
46

57
.. toctree::
68
:hidden:
7-
9+
810
internals
911
guidelines
+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
.. rubric:: For Developers
2+
3+
.. toctree::
4+
contributing/index
5+
frontend/index
6+
backend/index
7+
python-client/index
8+
specification/index
9+
changelog
10+
license

python-client/sphinx/index.rst

+1-7
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,7 @@ TIRA is a platform for experiments in artificial intelligence that ensures blind
2626
:caption: Development
2727
:hidden:
2828

29-
development/contributing/index
30-
development/frontend/index
31-
development/backend/index
32-
development/python-client/index
33-
development/specification/index
34-
development/changelog
35-
development/license
29+
development/index
3630

3731
Indices and tables
3832
==================

0 commit comments

Comments
 (0)