From 8999d9bb742db7b589be5fb2d8c2b4eb57fcc625 Mon Sep 17 00:00:00 2001 From: Ulyssa Date: Sun, 14 Apr 2024 11:00:10 -0700 Subject: [PATCH] Provide links for finding issues to work on (#25) --- src/development.md | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/src/development.md b/src/development.md index c1a74c2..2d14b5a 100644 --- a/src/development.md +++ b/src/development.md @@ -17,7 +17,7 @@ rustup toolchain install nightly --component rustfmt You will also likely want to use [rust-analyzer] during your development. Refer to its documentation for help on setting it up in your preferred editor. -## Programming In Rust +## Programming in Rust If you are new to Rust, some helpful resources to learn or refer to are: @@ -37,6 +37,20 @@ dependencies. Some of the libraries whose docs you may need are: - [ratatui] (see also the [ratatui book], which includes small demos and How-Tos) - [tokio] (see also the [tokio tutorial]) +## Finding an Issue + +You may already have an idea of a feature you want to add or a bug that's +affecting you, but if you're looking for something to get started learning +how to contribute to __iamb__, you can search for a [GitHub issue] that +interests you, and comment on it when you start working on it! + +A couple useful ways to search through the open issues are: + +- The [`good first issue`](https://github.com/ulyssa/iamb/labels/good%20first%20issue) label +- The [Future Release](https://github.com/ulyssa/iamb/milestone/5) milestone + for things that would be useful in __iamb__, but is currently unplanned/not + started. + ## Building, Formatting and Testing The commands you will want to run the most are: