Skip to content

Commit cdc4976

Browse files
AyanSinhaMahapatraAyanSinhaMahapatra
committed
Adds initial draft for Getting Started Section
Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>
1 parent f1b2414 commit cdc4976

7 files changed

Lines changed: 266 additions & 24 deletions

File tree

‎docs/source/scancode-toolkit/contribute/index.rst‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,3 +10,4 @@
1010
roadmap
1111
gsoc17_final_report
1212
gsoc19_final_report
13+
long_running_issues

‎docs/source/scancode-toolkit/contribute/long_running_issues.rst‎

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
Long Running Issues - Help Needed
2+
=================================
3+
4+
Long Running Issues - Scancode Toolkit
5+
--------------------------------------
6+
7+
- `Good First Issues List <https://github.com/nexB/scancode-toolkit/issues/1825>`_
8+
- `First Timers Only Issues List <https://github.com/nexB/scancode-toolkit/issues/1826>`_
9+
- `Add improved documentation for V3.0 <https://github.com/nexB/scancode-toolkit/issues/1146>`_
10+
- `Documentation Roadmap <https://github.com/nexB/scancode-toolkit/issues/1824>`_
11+
- `Documentation Inconsistencies Tracker <https://github.com/nexB/scancode-toolkit/issues/1813>`_
12+
13+
..
14+
[Suggestions for LRIs][ToDo]
15+
- People Interested in GSoC (And PRs Opened by Them)
16+
17+
Roadmaps
18+
--------
19+
20+
This section provides a overview of ScanCode developement roadmap, in the sense what maintainers
21+
are considering, what the long-term goals are.
22+
23+
- :ref:`roadmap`
24+
- `Milestones <https://github.com/nexB/scancode-toolkit/milestones>`_
25+
- `v3.1 <https://github.com/nexB/scancode-toolkit/milestone/11>`_
26+
- `v3.2 <https://github.com/nexB/scancode-toolkit/milestone/12>`_
27+
- `Documentation Roadmap <https://github.com/nexB/scancode-toolkit/issues/1824>`_
28+
29+
.. _good_first_issue:
30+
31+
Good First Issue
32+
----------------
33+
34+
A `good first issue <https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue>`_
35+
means it's recommended for people who haven't contributed to our codebase before.
36+
37+
A ``Solving Good First Issue`` is basically an issue based guide for new contributors to
38+
solve a ``Good First Issue``.
39+
40+
Manitainers of ScanCode Toolkit label small bugs as good first issues for new contributors.
41+
42+
Important Links
43+
^^^^^^^^^^^^^^^
44+
45+
- Issues labeled `good first issue <https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue>`_
46+
- The status `list of good first issue <https://github.com/nexB/scancode-toolkit/issues/1825>`_
47+
- opening a `Solving Good First Issue <https://github.com/nexB/scancode-toolkit/issues/new?assignees=&labels=first+issue+solving&template=--good-first-issue.md&title=>`_
48+
49+
What you should understand before Solving a Good First Issue
50+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
51+
52+
- ScanCode Toolkit tracks different kinds of `issues using GitHub <https://github.com/nexB/scancode-toolkit/issues/>`_.
53+
- Some of these issues are labeled ``Good First Issue`` by the Maintainers, as in they
54+
recommend them.
55+
- A list of ``Good First Issue`` is also maintained `here <https://github.com/nexB/scancode-toolkit/issues/1825>`_.
56+
- The list of ``Good First Issue`` contains a list of Issues, people assigned to them
57+
(or waiting to be assigned) and their status (active/completed).
58+
- Issues here are marked Solved using a `Task List <https://help.github.com/en/github/managing-your-work-on-github/about-task-lists>`_.
59+
- Contributors come at this issue (and not at individual issues) and ask the maintainers to
60+
be assigned.
61+
- After being assigned, contributors open another Issue labeled ``Solving Good First Issue``
62+
so maintainers can Track their Progress on that Issue.
63+
- The task list in the new issue opened (labeled ``Solving Good First Issue``) has to be updated by
64+
the Contributor.
65+
66+
Step by Step Workflow : Contributor's Tasks
67+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
68+
69+
#. Look at the Issues in `Good First Issues List <https://github.com/nexB/scancode-toolkit/issues/1825>`_
70+
These are basically all the `issues labeled Good First Issue <https://github.com/nexB/scancode-toolkit/labels/good%20first%20issue>`_
71+
with information on people assigned to the issues, and their status.
72+
73+
#. Select a ``Good First Issue`` which isn't assigned and comment in the `Good First Issues List <https://github.com/nexB/scancode-toolkit/issues/1825>`_
74+
asking the maintainers to assign you.
75+
76+
#. After you are assigned to that Issue by a maintainer, make sure you are assigned to the one you
77+
requested. It'll look like ``[ ] #1724 @AyanSinhaMahapatra`` where ``#1724`` is the Issue number
78+
and ``AyanSinhaMahapatra`` is your GitHub user ID.
79+
80+
#. Open an Issue labeled `Solving Good First Issue here <https://github.com/nexB/scancode-toolkit/issues/new?assignees=&labels=first+issue+solving&template=--good-first-issue.md&title=>`_ .
81+
82+
#. In this issue you opened, reference the following:
83+
(include ``#[number]`` in comments, like ``#1724``)
84+
85+
- The Original issue labeled ``Good First Issue`` that you are solving.
86+
- The Pull Request you open later.
87+
- The `Good First Issues List <https://github.com/nexB/scancode-toolkit/issues/1825>`_
88+
89+
#. Follow the Instruction on that Issue (It's a Template you'll just have to mark the Task List
90+
as you complete tasks)
91+
92+
- **Claim this issue**
93+
- **Reproduce**
94+
- **Create a Unit test**
95+
- **Come up with a Solution**
96+
- **Code your Solution**
97+
- **Run the tests locally**
98+
- **Commit and Push**
99+
- **Start a Pull Request**
100+
- **Make Sure all the Tests Pass**
101+
- **Done** Ask in comments for a review :)
102+
103+
#. Remind maintainers to close both Issues, after your Pull Request is Merged.
104+
105+
- The Original issue labeled ``Good First Issue``
106+
- The issue opened by you labeled ``Solving Good First Issue``
107+
108+
.. _first_timers_only:
109+
110+
First Timers Only
111+
-----------------
112+
113+
A `first timers only <https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only>`_.
114+
issue means we've worked to make it more legible to folks who either **haven't contributed to our
115+
codebase before, or even folks who haven't contributed to open source before**.
116+
117+
Small documenation inconsistencies are first timers only issues for new contributors.
118+
119+
Important Links
120+
^^^^^^^^^^^^^^^
121+
122+
- Issues labeled `first timers only <https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only>`_
123+
- The status list of `all first timers only <https://github.com/nexB/scancode-toolkit/issues/1826>`_ Issues
124+
- All `Documentation Inconsistencies Issue <https://github.com/nexB/scancode-toolkit/issues/1813>`_.
125+
- opening a `First Timers Only Issue <https://github.com/nexB/scancode-toolkit/issues/new?assignees=&labels=first+timers+only&template=--first-timers-only.md&title=>`_
126+
127+
What you should understand before Solving a First Timers Only Issue
128+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
129+
130+
- ScanCode Toolkit tracks different kinds of `issues using GitHub <https://github.com/nexB/scancode-toolkit/issues/>`_.
131+
- Some of these issues are documentation inconsistencies `listed here <https://github.com/nexB/scancode-toolkit/issues/1813>`_.
132+
- A list of ``First Timers Only`` Issues is also `maintained here <https://github.com/nexB/scancode-toolkit/issues/1826>`_.
133+
- The list of ``First Timers Only`` contains a list of Issues, people assigned to them
134+
(or waiting to be assigned) and their status (active/completed).
135+
- Issues here are marked Solved using a `Task List <https://help.github.com/en/github/managing-your-work-on-github/about-task-lists>`_.
136+
- Contributors come at this issue and ask the maintainers to be assigned.
137+
- After being assigned, contributors open another Issue labeled ``First Timers Only``
138+
so maintainers can Track their Progress.
139+
- The task list has to be updated by the Contributor.
140+
141+
Step by Step Workflow : Contributor's Tasks
142+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
143+
144+
#. Look at the Issues in ``First Timers Only`` `List <https://github.com/nexB/scancode-toolkit/issues/1825>`_
145+
These are basically all the `issues <https://github.com/nexB/scancode-toolkit/labels/%20first%20timers%20only>`_
146+
labeled ``First Timers Only`` issues, with information on people assigned to the issues,
147+
and their status.
148+
149+
#. Select a ``First Timers Only`` issue which isn't assigned to anyone yet, and comment on the
150+
`List <https://github.com/nexB/scancode-toolkit/issues/1825>`_ asking the maintainers to assign
151+
you.
152+
153+
#. After you are assigned to that Issue by a maintainer, make sure you are assigned to the one you
154+
requested. It'll look like ``[ ] #1724 @AyanSinhaMahapatra`` where ``#1724`` is the Issue number
155+
and ``AyanSinhaMahapatra`` is your GitHub user ID.
156+
157+
#. Open an Issue labeled `First Timers Only here <https://github.com/nexB/scancode-toolkit/issues/new?assignees=&labels=first+timers+only&template=--first-timers-only.md&title=>`_ .
158+
159+
#. In this issue you opened, reference the following:
160+
(include ``#[number]`` in comments, like ``#1724``)
161+
162+
- The Original issue labeled ``Good First Issue`` that you are solving.
163+
- The Pull Request you open later.
164+
- The `Good First Issues List <https://github.com/nexB/scancode-toolkit/issues/1825>`_
165+
166+
#. Follow the Instruction on that Issue (It's a Template you'll just have to mark the Task List
167+
as you complete tasks)
168+
169+
- **Issue Claimed**
170+
- **Review Guidelines**
171+
- **Refer Documentation**
172+
- **Build Docs Locally**
173+
- **Update**
174+
- **Commit and Push**
175+
- **Start a Pull Request**
176+
- **Make Sure all the Tests Pass**
177+
- **Done** Ask in comments for a review :)

‎docs/source/scancode-toolkit/contribute/roadmap.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _roadmap:
2+
13
Roadmap
24
=======
35

‎docs/source/scancode-toolkit/getting-started/docs.rst‎

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

‎docs/source/scancode-toolkit/getting-started/index.rst‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
home
88
install
99
ide-config
10-
docs
1110
whats-new
11+
newcomer
1212

1313
..
1414
[ToAdd]
15-
releases
1615
Link to Changelog

‎docs/source/scancode-toolkit/getting-started/newcomer.rst‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
Are you new to Scancode-Toolkit?
2+
================================
3+
4+
This is the perfect place to start from if you are new to ScanCode-Toolkit.
5+
6+
Table of Contents
7+
-----------------
8+
9+
#. :ref:`newcomer_start_using_scancode`
10+
11+
- :ref:`newcomer_scan_codebase`
12+
- :ref:`newcomer_use_scancode_better`
13+
- :ref:`newcomer_all_tutorials`
14+
15+
#. :ref:`newcomer_contribute`
16+
17+
- :ref:`newcomer_code`
18+
- :ref:`newcomer_good_first_issue`
19+
- :ref:`newcomer_add_functionalirty`
20+
- :ref:`newcomer_more_support`
21+
- :ref:`newcomer_gsoc_gsod`
22+
- :ref:`newcomer_update_docs`
23+
24+
.. _newcomer_start_using_scancode:
25+
26+
Start Using ScanCode Toolkit
27+
----------------------------
28+
29+
.. _newcomer_scan_codebase:
30+
31+
Scan a Codebase
32+
^^^^^^^^^^^^^^^
33+
34+
.. _newcomer_use_scancode_better:
35+
36+
Use ScanCode Better
37+
^^^^^^^^^^^^^^^^^^^
38+
39+
.. _newcomer_all_tutorials:
40+
41+
All Tutorials/How-Tos
42+
^^^^^^^^^^^^^^^^^^^^^
43+
44+
45+
.. _newcomer_contribute:
46+
47+
Contribute
48+
----------
49+
50+
.. _newcomer_code:
51+
52+
Contribute Code
53+
^^^^^^^^^^^^^^^
54+
55+
.. _newcomer_good_first_issue:
56+
57+
Good First Issues
58+
^^^^^^^^^^^^^^^^^
59+
60+
.. _newcomer_add_functionalirty:
61+
62+
Add new Functionality to ScanCode
63+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
64+
65+
66+
.. _newcomer_more_support:
67+
68+
Where we need more Support
69+
^^^^^^^^^^^^^^^^^^^^^^^^^^
70+
71+
72+
.. _newcomer_gsoc_gsod:
73+
74+
Participate in GSoC/GSoD
75+
^^^^^^^^^^^^^^^^^^^^^^^^
76+
77+
.. _newcomer_update_docs:
78+
79+
Update our Documentation
80+
^^^^^^^^^^^^^^^^^^^^^^^^
81+
82+

‎docs/source/scancode-toolkit/getting-started/whats-new.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ This is the first 3.1 release with the best, fastest and most efficient ScanCode
2020
This release contains many improvements, fixes and new features including breaking API changes (when compared to 2.2.x). See the `CHANGELOG <https://github.com/nexB/scancode-toolkit/blob/master/CHANGELOG.rst>`_ for details.
2121

2222
This release also comes with a Full Documentation hosted at
23-
aboutcode.readthedocs.io/en/latest/scancode-toolkit/.
23+
`aboutcode.readthedocs.io <aboutcode.readthedocs.io/en/latest/scancode-toolkit/>`_.
2424

2525
To install, download scancode-toolkit-3.1.1.zip or scancode-toolkit-3.1.1.tar.bz2 from the Downloads section below and follow installation instructions in the `README <https://github.com/nexB/scancode-toolkit/blob/master/README.rst>`_.
2626

@@ -38,8 +38,8 @@ Brief Summary Of Changes
3838
Documentation Support
3939
^^^^^^^^^^^^^^^^^^^^^
4040

41-
``pip install``
42-
^^^^^^^^^^^^^^^
41+
``pip install`` Support
42+
^^^^^^^^^^^^^^^^^^^^^^^
4343

4444
Python 3 Support
4545
^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)