11.. _contributing :
22
3- Contributing to ScanCode.io
3+ Contributing to AboutCode
44===========================
55
6- Thank you so much for being so interested in contributing to ScanCode.io . We
6+ Thank you so much for being so interested in contributing to AboutCode . We
77are always on the lookout for enthusiastic contributors like you who can make
88our project better, and we're willing to lend a helping hand if you have any
99questions or need guidance along the way. That being said, here are a few
@@ -17,25 +17,22 @@ Do Your Homework
1717----------------
1818
1919Before adding a contribution or create a new issue, take a look at the project’s
20- `README <https://github.com/aboutcode-org/scancode.io#readme >`_, read through our
21- `documentation <https://scancodeio.readthedocs.io/en/latest/ >`_,
22- and browse existing `issues <https://github.com/aboutcode-org/scancode.io/issues >`_,
23- to develop some understanding of the project and confirm whether a given
20+ README, read through existing documentation, and browse existing issues to
21+ develop some understanding of the project and confirm whether a given
2422issue/feature has previously been discussed.
2523
2624Ways to Contribute
2725------------------
2826
29- Contributing to the codebase is not the only way to add value to ScanCode.io or
27+ Contributing to the codebase is not the only way to add value to AboutCode or
3028join our community. Below are some examples to get involved:
3129
3230First Timers
3331^^^^^^^^^^^^
3432
3533You are here to help, but you're a new contributor! No worries, we always
36- welcome newcomer contributors. We maintain some
37- `good first issues <https://github.com/aboutcode-org/scancode.io/labels/good%20first%20issue >`_
38- and encourage new contributors to work on those issues for a smooth start.
34+ welcome newcomer contributors. We maintain some good first issues and encourage
35+ new contributors to work on those issues for a smooth start.
3936
4037.. warning ::
4138 **"Can I work on this issue?" **
@@ -55,12 +52,10 @@ and encourage new contributors to work on those issues for a smooth start.
5552Report Issues
5653^^^^^^^^^^^^^
5754
58- - Report a new `bug <https://github.com/aboutcode-org/scancode.io/issues >`_; just remember to be
59- as specific as possible.
60- - Create a `new issue <https://github.com/aboutcode-org/scancode.io/issues >`_ to request a
61- feature, submit a feedback, or ask a question.
62- - Look into existing `bugs <https://github.com/aboutcode-org/scancode.io/labels/bug >`_,
63- try to reproduce the issue on your side, and discuss solutions in the comments.
55+ - Report a new bug, issue, questions, or suggestions in the "Issues" page of the
56+ project's GitHub repo; just remember to be as specific as possible.
57+ - Look into existing bugs and try to reproduce the issue on your side, and
58+ discuss solutions in the comments.
6459
6560.. note ::
6661 Make sure to check existing `issues <https://github.com/aboutcode-org/scancode.io/issues >`_,
@@ -70,10 +65,10 @@ Report Issues
7065Code Contributions
7166^^^^^^^^^^^^^^^^^^
7267
73- Code is contributed to the codebase using **pull requests **.
74- A pull request should always be attached to an existing issue.
75- When there is no existing issues, start by ` creating one < https://github.com/aboutcode-org/scancode.io/issues >`_
76- to discuss potential solutions and implementation details before writing any code.
68+ Code is contributed to the codebase using **pull requests **. A pull request
69+ should always be attached to an existing issue. When there is no existing
70+ issues, create one to discuss potential solutions and implementation details
71+ before writing any code.
7772
7873We use several conventions to ensure code quality regarding format, testing, and
7974attribution.
@@ -115,29 +110,27 @@ Documentation Improvements
115110^^^^^^^^^^^^^^^^^^^^^^^^^^
116111
117112Documentation is a critical aspect of any project that is usually neglected or
118- overlooked. We value any suggestions to improve
119- `ScanCode.io documentation <https://scancodeio.readthedocs.io/en/latest/ >`_.
113+ overlooked. We value any suggestions to improve ours.
120114
121115.. tip ::
122116 Our documentation is treated like code. Make sure to check our
123- `writing guidelines <https://scancode-toolkit.readthedocs.io/en/latest/contribute/contrib_doc.html >`_
124- to help guide new users.
117+ :ref: `writing guidelines <contrib_doc_dev >` to help guide new users.
125118
126119Other Ways
127120^^^^^^^^^^
128121
129- You want to contribute to other aspects of the ScanCode.io project , and you
130- can't find what you're looking for! You can always discuss new topics, ask
131- questions, and interact with us and other community members on
122+ You want to contribute to other aspects of AboutCode , and you can't find what
123+ you're looking for! You can always discuss new topics, ask questions, and
124+ interact with us and other community members on
132125`Gitter <https://gitter.im/aboutcode-org/discuss >`_.
133126
134127.. _contributing_resources :
135128
136129Helpful Resources
137130-----------------
138131
139- - Review our `comprehensive guide <https://scancode-toolkit.readthedocs.io/en/latest/contribute/index.html >`_
140- for more details on how to add quality contributions to our codebase and documentation
132+ - Review our :ref: `comprehensive guide <contrib_doc_dev >` for more details on
133+ how to add quality contributions to our codebase and documentation
141134- Check this free resource on `how to contribute to an open source project on github <https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github >`_
142135- Follow `this wiki page <https://aboutcode.readthedocs.io/en/latest/contributing/writing_good_commit_messages.html >`_
143136 on how to write good commit messages
0 commit comments