Skip to content

Conversation

@toddlamothe
Copy link
Contributor

Re-added some lost content by creating subpages linked from the main readme

Copy link
Contributor

@smara-codes smara-codes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, thanks for bringing back some of the context!

Copy link
Contributor

@rallytime rallytime left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍🏻

I added a small suggestion since you're working on these docs, but it's certainly not a blocker.

## Quality

- prioritize quality over speed | [the only way to go fast is to go well](http://butunclebob.com/ArticleS.UncleBob.VehementMediocrity)
- [test, automate, test, automate](docs/automate-tests.md)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Might be a good time to mention using linting tools or other kinds of automated robot-tasks that make it easier to review PRs?

For example, the usm-apis repo runs a couple of easy-automated formatters that keep the code clean. These can run as part of the commit process itself if desired. They also run a part of the CI/CD checks upon PR submission and must pass before PR merge.

https://github.com/unionstreetmedia/usm-apis/blob/main/CONTRIBUTING.md#code-style

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree. Ok if I merge this PR and we can add linting separately?

@toddlamothe toddlamothe merged commit 032453a into main Dec 14, 2021
@toddlamothe toddlamothe deleted the subpages branch December 14, 2021 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants