improved the CONTRIBUTING.md documentation #3026
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
racheallovee
requested review from
jcristau,
gbrownmozilla and
gabrielbusta
as code owners
bhearsum
requested changes
Oct 25, 2023
| In order to effectively work on Balrog you will need to be able to both run its tests and local development environment. You will need a recent version of Docker, Docker Compose, and tox to do these things. | ||
| - [Admin](https://github.com/mozilla-releng/balrog/labels/admin): Administrative tasks | ||
| - [Agent](https://github.com/mozilla-releng/balrog/labels/agent): Agent-related tasks | ||
| - [Public](https://github.com/mozilla-releng/balrog/labels/public): Public-facing tasks |
There was a problem hiding this comment.
Admin, Agent, and Public are all different applications written in Python. (admin and public are webapps, agent is a small damon.)
| - [Agent](https://github.com/mozilla-releng/balrog/labels/agent): Agent-related tasks | ||
| - [Public](https://github.com/mozilla-releng/balrog/labels/public): Public-facing tasks | ||
| - [DB](https://github.com/mozilla-releng/balrog/labels/db): Database-related tasks (written in Python) | ||
| - [Frontend](https://github.com/mozilla-releng/balrog/labels/frontend): Frontend tasks (written in React) |
There was a problem hiding this comment.
issues would be a better word to use here than tasks.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I did some few changes and improved the CONTRIBUTING.md file to provide clearer instructions
for setting up the development environment and finding suitable issues to work on.🙂