Skip to content

Commit c5f180f

Browse files
docs: adapt contributing guidelines based on how Omnipath team work.
1 parent 9d0fe35 commit c5f180f

4 files changed

Lines changed: 24 additions & 3 deletions

File tree

29.1 KB
Loading

docs/community/CONTRIBUTING.md

Whitespace-only changes.

docs/community/code-of-conduct.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Code of Conduct
2+
3+
This project follows the Contributor Covenant v2.1.
4+
5+
- View the full text in the repository: [Code of Conduct](https://github.com/saezlab/ontograph/blob/main/CODE_OF_CONDUCT.md)
6+
- [Contributor Covenant website](https://www.contributor-covenant.org/version/2/1/code_of_conduct/)
7+
8+
If you need to report a concern, please email: [edwin.carreno@iwr.uni-heidelberg.de](mailto:edwin.carreno@iwr.uni-heidelberg.de)

docs/community/index.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
Welcome to the ontograph community! We follow open-source principles and
2-
encourage any sort of contribution. We communicate on GitHub, where we also
2+
encourage any sort of contribution. We communicate on [GitHub](https://github.com/saezlab/ontograph), where we also
33
organise our projects.
44

5-
> Please review our [Code of Conduct](../../CODE_OF_CONDUCT.md) before participating in issues, discussions, and pull requests.
5+
!!! note
6+
Please review our [Code of Conduct](code-of-conduct.md) before participating in issues, discussions, and pull requests.
67

78
<div class="grid cards" markdown>
89

@@ -17,8 +18,20 @@ organise our projects.
1718

1819
</div>
1920

21+
<div class="grid cards" markdown>
22+
23+
- :octicons-list-unordered-24:{ .lg .middle } __Contributing Overview__
24+
25+
---
26+
27+
A concise checklist and best practices for contributing.
28+
29+
[:octicons-arrow-right-24: Open overview](CONTRIBUTING.md)
30+
31+
</div>
32+
2033

2134
## Contributing Guidelines GitHub Links
2235

2336
- Contribution guidelines (coming soon in this docs section)
24-
- [Code of Conduct](../../CODE_OF_CONDUCT.md)
37+
- [Code of Conduct](code-of-conduct.md)

0 commit comments

Comments
 (0)