Skip to content

Commit

Permalink
Provide links for finding issues to work on (#25)
Browse files Browse the repository at this point in the history
  • Loading branch information
ulyssa authored Apr 14, 2024
1 parent 01fad5f commit 8999d9b
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion src/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:
Expand Down

0 comments on commit 8999d9b

Please sign in to comment.