Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: create a doc for the help wanted label #817

Merged
merged 1 commit into from
Jul 6, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/development/help-wanted.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Help Wanted Issues

These issues should be suitable for someone who has either contributed to the project before, or an experienced developer who is comfortable navigating a new codebase.

Items marked with the "help wanted" label should meet the following standards:

- Medium to Low Priority
- Low barrier to entry: this should be harder than "good first issue," but still, the difficulty should be limited to a reasonable level.
- Tractable for new contributors. Documentation on how that type of change should be made should already exist.
- Clearly defined and agreed upon and does not require further discussions. Point it out if that area of code is untested and requires new fixtures. When possible, point to existing code that serves as an example of how to implement the change.
- API/CLI behavior is decided and included in the original issue, for example: "The new command syntax is dtm xxx NAME [--some-flag] [--timeout 5m]", with expected input validations, output, and error handling defined.

Tips for creating help wanted issues:

- Only select issues that aren't in key pathways, or must be done quickly: you don't want to put effort into grooming these issues, then end up having to do it yourself because it must be done soon.
- Keep them up-to-date: regularly review these issues, and make sure that they haven't already been implemented, aren't necessary anymore, and the suggested solution or design is still appropriate.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -110,5 +110,6 @@ nav:
- development/commands/develop*.md
- development/reviewing*.md
- development/good-first-issues*.md
- development/help-wanted*.md
- development/branch-and-release*.md
- Road Map ⧉: https://github.com/devstream-io/devstream/blob/main/ROADMAP.md