Long Running Issues - Help Needed

Roadmaps

This section provides a overview of ScanCode developement roadmap, in the sense what maintainers are considering, what the long-term goals are.

Good First Issue

A good first issue means it’s recommended for people who haven’t contributed to our codebase before.

A Solving Good First Issue is basically an issue based guide for new contributors to solve a Good First Issue.

Manitainers of ScanCode Toolkit label small bugs as good first issues for new contributors.

What you should understand before Solving a Good First Issue

  • ScanCode Toolkit tracks different kinds of issues using GitHub.

  • Some of these issues are labeled Good First Issue by the Maintainers, as in they recommend them.

  • A list of Good First Issue is also maintained here.

  • The list of Good First Issue contains a list of Issues, people assigned to them (or waiting to be assigned) and their status (active/completed).

  • Issues here are marked Solved using a Task List.

  • Contributors come at this issue (and not at individual issues) and ask the maintainers to be assigned.

  • After being assigned, contributors open another Issue labeled Solving Good First Issue so maintainers can Track their Progress on that Issue.

  • The task list in the new issue opened (labeled Solving Good First Issue) has to be updated by the Contributor.

Step by Step Workflow : Contributor’s Tasks

  1. Look at the Issues in Good First Issues List These are basically all the issues labeled Good First Issue with information on people assigned to the issues, and their status.

  2. Select a Good First Issue which isn’t assigned and comment in the Good First Issues List asking the maintainers to assign you.

  3. After you are assigned to that Issue by a maintainer, make sure you are assigned to the one you requested. It’ll look like [ ] #1724 @AyanSinhaMahapatra where #1724 is the Issue number and AyanSinhaMahapatra is your GitHub user ID.

  4. Open an Issue labeled Solving Good First Issue here .

  5. In this issue you opened, reference the following: (include #[number] in comments, like #1724)

    • The Original issue labeled Good First Issue that you are solving.

    • The Pull Request you open later.

    • The Good First Issues List

  6. Follow the Instruction on that Issue (It’s a Template you’ll just have to mark the Task List as you complete tasks)

    • Claim this issue

    • Reproduce

    • Create a Unit test

    • Come up with a Solution

    • Code your Solution

    • Run the tests locally

    • Commit and Push

    • Start a Pull Request

    • Make Sure all the Tests Pass

    • Done Ask in comments for a review :)

  7. Remind maintainers to close both Issues, after your Pull Request is Merged.

    • The Original issue labeled Good First Issue

    • The issue opened by you labeled Solving Good First Issue

First Timers Only

A first timers only. issue means we’ve worked to make it more legible to folks who either haven’t contributed to our codebase before, or even folks who haven’t contributed to open source before.

Small documenation inconsistencies are first timers only issues for new contributors.

Important Links

What you should understand before Solving a First Timers Only Issue

  • ScanCode Toolkit tracks different kinds of issues using GitHub.

  • Some of these issues are documentation inconsistencies listed here.

  • A list of First Timers Only Issues is also maintained here.

  • The list of First Timers Only contains a list of Issues, people assigned to them (or waiting to be assigned) and their status (active/completed).

  • Issues here are marked Solved using a Task List.

  • Contributors come at this issue and ask the maintainers to be assigned.

  • After being assigned, contributors open another Issue labeled First Timers Only so maintainers can Track their Progress.

  • The task list has to be updated by the Contributor.

Step by Step Workflow : Contributor’s Tasks

  1. Look at the Issues in First Timers Only List These are basically all the issues labeled First Timers Only issues, with information on people assigned to the issues, and their status.

  2. Select a First Timers Only issue which isn’t assigned to anyone yet, and comment on the List asking the maintainers to assign you.

  3. After you are assigned to that Issue by a maintainer, make sure you are assigned to the one you requested. It’ll look like [ ] #1724 @AyanSinhaMahapatra where #1724 is the Issue number and AyanSinhaMahapatra is your GitHub user ID.

  4. Open an Issue labeled First Timers Only here .

  5. In this issue you opened, reference the following: (include #[number] in comments, like #1724)

    • The Original issue labeled Good First Issue that you are solving.

    • The Pull Request you open later.

    • The Good First Issues List

  6. Follow the Instruction on that Issue (It’s a Template you’ll just have to mark the Task List as you complete tasks)

    • Issue Claimed

    • Review Guidelines

    • Refer Documentation

    • Build Docs Locally

    • Update

    • Commit and Push

    • Start a Pull Request

    • Make Sure all the Tests Pass

    • Done Ask in comments for a review :)