Skip to content

Commit 3c817c1

Browse files
authored
Merge pull request #55 from nexB/add-contrib-page
Add Contribution Document Page
2 parents 176b463 + 80bbc48 commit 3c817c1

5 files changed

Lines changed: 51 additions & 25 deletions

File tree

docs/source/coding-toc.rst

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/source/contributing.rst

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
############
2+
Contributing
3+
############
4+
The AboutCode organization welcomes you and your interest in contributing to our
5+
organization. We are always looking for enthusiatic contributors and we are willing to
6+
lend a helping hand if you have any questions or comments. That being said, here a few
7+
resources to help you get started.
8+
9+
1) Take a look through our public repos here: https://github.com/nexB/
10+
* Find one you are interested in and check out its open **Issues**
11+
2) If you have specific questions browse through our documentation here: https://aboutcode.readthedocs.io/en/latest/
12+
* Depending on the project, there may be a seperate ReadTheDocs website
13+
* If you did not find what you were looking for or you still have questions,
14+
open an issue on the relevant repository, or ask directly via Gitter
15+
16+
You can always interact with the AboutCode organization and our extended community on Gitter_
17+
18+
.. _Gitter: https://gitter.im/aboutcode-org/discuss
19+
20+
************************
21+
Contribution Guidelines:
22+
************************
23+
24+
.. toctree::
25+
:maxdepth: 2
26+
27+
contributing/writing_good_commit_messages
28+
contributing/testing

docs/source/coding-principles/writing_good_commit_messages.rst renamed to docs/source/contributing/writing_good_commit_messages.rst

File renamed without changes.

docs/source/index.rst

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,49 +1,61 @@
1+
#######################
12
AboutCode Documentation
2-
=======================
3+
#######################
34

45
Welcome to the AboutCode documentation.
56

67
This set of documents provides an overview of the AboutCode Projects sponsored by
78
AboutCode.org (https://www.aboutcode.org), as well as references to the various GitHub project
89
sites that maintain the actual projects and their documentation.
910

10-
All community contributions are welcome. Note that AboutCode.org is applying to participate in
11-
the 2020 Google Season of Docs (`GSoD 2020 <https://developers.google.com/season-of-docs>`_).
11+
All community contributions are welcome.
1212

1313
----
1414

15+
***************************
16+
AboutCode Organization Docs
17+
***************************
18+
1519
.. toctree::
16-
:maxdepth: 2
20+
:maxdepth: 1
1721

22+
contributing
23+
doc_guidelines
1824
aboutcode-project-overview
1925
aboutcode-data/abcd
20-
coding-toc
21-
doc_guidelines
22-
gsoc-toc
23-
gsod-toc
2426
license
2527

2628
.. aboutcode-docs/home
2729
2830
----
2931

32+
33+
**********************
34+
AboutCode Project Docs
35+
**********************
36+
3037
.. toctree::
31-
:maxdepth: 2
38+
:maxdepth: 1
3239

3340
aboutcode-toolkit/index
3441

3542

36-
3743
.. toctree::
38-
:maxdepth: 2
44+
:maxdepth: 1
3945

4046
deltacode/index
4147

4248
----
4349

50+
**************
51+
Community Docs
52+
**************
53+
4454
.. toctree::
4555
:maxdepth: 2
4656

57+
gsoc-toc
58+
gsod-toc
4759
contributor_project_ideas
4860

4961

0 commit comments

Comments
 (0)