Skip to content

Commit

Permalink
docs(contributing): add non-code section
Browse files Browse the repository at this point in the history
  • Loading branch information
keyserj authored Oct 7, 2024
1 parent df27d45 commit c3798c0
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,12 +37,16 @@ There are also [quite a few ideas](https://github.com/orgs/amelioro/projects/2/v

## Finding an issue to work on

Check out the [first issues filter](https://github.com/orgs/amelioro/projects/2/views/7) in the project backlog - https://github.com/amelioro/ameliorate/labels/good%20first%20issue s have a narrow scope and are expected to entail a small number of changes, and https://github.com/amelioro/ameliorate/labels/ok%20first%20issue s have a narrow scope, but are expected to be a bit tougher. You can check out the [backlog of all issues](https://github.com/orgs/amelioro/projects/2/views/1) if you're feeling daring, plucky, or if this isn't your first rodeo. This list should be prioritized, but you don't need to limit yourself to the top.
Check out the [first issues filter](https://github.com/orgs/amelioro/projects/2/views/7) in the project backlog - https://github.com/amelioro/ameliorate/labels/good%20first%20issue s have a narrow scope and are expected to entail a small number of changes, and https://github.com/amelioro/ameliorate/labels/ok%20first%20issue s have a narrow scope, but are expected to be a bit tougher. There are also https://github.com/amelioro/ameliorate/labels/non-code issues that can be good if you want to help out for learning about the tool rather than the code behind it. You can check out the [backlog of all issues](https://github.com/orgs/amelioro/projects/2/views/1) if you're feeling daring, plucky, or if this isn't your first rodeo. This list should be prioritized, but you don't need to limit yourself to the top.

Feel free to clarify any issues via commenting on the issue or asking in [Discord](https://discord.gg/3KhdyJkTWT). When you find an issue you want to work on, please comment on it to avoid duplicating work on it.

Note: be particularly wary of [issues with a "needs [x]" label](https://github.com/orgs/amelioro/projects/2/views/9) - these are expected to require significant design efforts.

### Non-code contributions

There are many ways to contribute without coding! Providing feedback, building example diagrams, joining [discourse sessions](https://ameliorate.app/docs/discourse-sessions), sharing about the tool, creating/updating docs, etc. Check out the https://github.com/amelioro/ameliorate/labels/non-code issues for some specific tickets.

## Running the project

Make sure you have [git](https://git-scm.com/downloads), [nvm](https://github.com/nvm-sh/nvm?tab=readme-ov-file#installing-and-updating) (or your preferred node version manager), and [docker](https://docs.docker.com/get-docker/) installed. If you're on Windows, you may also need to install [WSL](https://learn.microsoft.com/en-us/windows/wsl/install#install-wsl-command) to run the bash setup scripts.
Expand Down

0 comments on commit c3798c0

Please sign in to comment.