Skip to content

Commit

Permalink
Make it easier to find the repo overview (#160)
Browse files Browse the repository at this point in the history
  • Loading branch information
lewisdaly authored and Sam committed Jan 24, 2020
1 parent 95b0dd2 commit 85c0467
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
3 changes: 2 additions & 1 deletion contributors-guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@
## How do I contribute?

* Review the [Mojaloop Deployment](../deployment-guide/) Guide and the [Onboarding Guide](https://github.com/mojaloop/mojaloop/blob/master/onboarding.md)
* Browse through the [Repository Overview](../repositories/) to understand how the Mojaloop code is managed across multiple Github Repositories
* Get familiar with our [Standards](standards/) on contributing to this project
* View the project board and work on your [good first issue](https://github.com/mojaloop/project/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
* Review the [Roadmap](../mojaloop-roadmap.md) and contribute to future opportunities

## What work is needed?

Work is tracked as issues in GitHub. You'll see issues there that are open and marked as bugs, stories, or epics. An epic is larger work that contains multiple stories. Start with any stories that are marked with "[good first issue](https://github.com/mojaloop/project/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)". In addition, anything that is in the backlog and not assigned to someone are things we could use help with. Stories that have owners are in someone's backlog already, though you can always ask about them in the issue or on Slack.
Work is tracked as issues in the [mojaloop/project](https://github.com/mojaloop/project) repository GitHub. You'll see issues there that are open and marked as bugs, stories, or epics. An epic is larger work that contains multiple stories. Start with any stories that are marked with "[good first issue](https://github.com/mojaloop/project/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)". In addition, anything that is in the backlog and not assigned to someone are things we could use help with. Stories that have owners are in someone's backlog already, though you can always ask about them in the issue or on Slack.

There's a [roadmap](../mojaloop-roadmap.md) that shows larger work that people could do or are working on. It has some main initiatives and epics and the order, but lacks dates as this work is community driven. Work is broken down from there into issues in GitHub.

Expand Down
2 changes: 1 addition & 1 deletion repositories/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Repository overview

# Repository Details

The Mojaloop project is organized on the basis of component microservices. As such, there are over twenty different repositories in GitHub that align to the different services. The following four repositories are pinned to the project:
The [Mojaloop project](https://github.com/mojaloop) is organized on the basis of component microservices. As such, there are over twenty different repositories in GitHub that align to the different services. The following repositories are pinned to the project:

* The [mojaloop repository](https://github.com/mojaloop/mojaloop) contains the master readme file along with the following documents to get started.
* The [documentation repository](https://github.com/mojaloop/documentation) documents the contributors guidelines, overall architecture, component design, message flow, and an overview of Mojaloop. _(__Note:__ This gitbook you are currently reading is generated from the documentation repository)_
Expand Down

0 comments on commit 85c0467

Please sign in to comment.