diff --git a/_contrib/governance.md b/_contrib/governance.md index 1ca534e..0b88af8 100644 --- a/_contrib/governance.md +++ b/_contrib/governance.md @@ -20,21 +20,21 @@ users. Some actively contribute their thoughts, but many others we must seek out to learn about their usage, joys, and headaches. Those insights allow our experts to determine the best solutions for the users. -We then define a set of [TENETS](./TENETS.md), which are guiding principles +We then define a set of [TENETS](./tenets.md), which are guiding principles that can be used to measure aspects of individual decisions. It should be possible to identify one or more tenets that apply to why a decision is made. And the set helps us balance which priorities are more important for our users. -We combine the usecases with the tenets to come up with a [VISION](./VISION.md) +We combine the usecases with the tenets to come up with a [VISION](./vision.md) that provides a longer-term plan of what hyper _should_ look like. -Finally, we define a [ROADMAP](./ROADMAP.md) that describes what the +Finally, we define a [ROADMAP](./roadmap.md) that describes what the short-term, tactical changes to bring hyper closer in line with the vision. ## Roles These are the roles people can fill when participating in the project. A list -of the people in each role is available in [MAINTAINERS](./MAINTAINERS.md). +of the people in each role is available in [MAINTAINERS](./maintainers.md). ### Contributor @@ -69,7 +69,7 @@ How to become: - Make a few [contributions][contrib] to the project, to show you can follow the [Code of Conduct][coc]. - Self-nominate by making a pull request adding yourself to the - [list](./MAINTAINERS.md#triagers). + [list](./maintainers.md#triagers). ### Collaborator @@ -79,7 +79,7 @@ Collaborators are contributors who have been helping out in a consistent basis. Responsibilities: - Be exemplars of the [Code of Conduct][coc] -- Internalize the [VISION](./VISION.md) +- Internalize the [VISION](./vision.md) - Reviewing pull requests from other contributors - Provide feedback on proposed features and design documents - [Welcome new contributors][triage-guide] @@ -106,9 +106,9 @@ goal! ### Maintainer Maintainers are the project admins. Besides being a collaborator, they take care -house-keeping duties, help lead the direction, and have the final authority when +of house-keeping duties, help lead the direction, and have the final authority when required. -[coc]: ./CODE_OF_CONDUCT.md +[coc]: ./code_of_conduct.md [contrib]: ../CONTRIBUTING.md -[triage-guide]: ./ISSUES.md#triaging +[triage-guide]: ./issues.md#triaging diff --git a/_contrib/index.md b/_contrib/index.md index 68b5616..c94aaee 100644 --- a/_contrib/index.md +++ b/_contrib/index.md @@ -4,4 +4,4 @@ layout: guide permalink: /contrib/ --- -This set of documents outline how hyper is developed, how to contribute or get involved, various processes we use, and internal design explanations. +This is a set of documents outline how hyper is developed, how to contribute or get involved, various processes we use, and internal design explanations. diff --git a/_contrib/issues.md b/_contrib/issues.md index 6b7ceeb..587acf7 100644 --- a/_contrib/issues.md +++ b/_contrib/issues.md @@ -38,7 +38,7 @@ to include them all. ### Categorize Once enough information has been gathered, the issue should be categorized -with [labels][#labels]. Ideally, most issues should be labelled with an area, +with [labels](#labels). Ideally, most issues should be labelled with an area, effort, and severity. An issue _can_ have multiple areas, pick what fits. There should be only one severity, and the descriptions of each should help to pick the right one. The hardest label to select is "effort". If after reading the @@ -112,5 +112,6 @@ The severity marks how _severe_ the issue is. Note this isn't "importance" or "p - **S-refactor**: improve internal code to help readability and maintenance. [issues]: https://github.com/hyperium/hyper/issues -[COC]: ./CODE_OF_CONDUCT.md -[PRs]: ./PULL_REQUESTS.md +[COC]: ./code_of_conduct.md +[PRs]: ./pull_requests.md +[MRE]: https://en.wikipedia.org/wiki/Minimal_reproducible_example diff --git a/_contrib/maintainers.md b/_contrib/maintainers.md index 586c296..b163998 100644 --- a/_contrib/maintainers.md +++ b/_contrib/maintainers.md @@ -3,7 +3,7 @@ title: The People layout: guide --- -To see what these roles do, and how to become one, look at [GOVERNANCE](./GOVERNANCE.md). +To see what these roles do, and how to become one, look at [GOVERNANCE](./governance.md). ## Triagers diff --git a/_contrib/pull-requests.md b/_contrib/pull-requests.md index c62b480..3b3a0f7 100644 --- a/_contrib/pull-requests.md +++ b/_contrib/pull-requests.md @@ -8,7 +8,7 @@ Pull requests are the way to submit changes to the hyper repository. ## Submitting a Pull Request In most cases, it a good idea to discuss a potential change in an -[issue](ISSUES.md). This will allow other contributors to provide guidance and +[issue](issues.md). This will allow other contributors to provide guidance and feedback _before_ significant code work is done, and can increase the likelihood of getting the pull request merged. @@ -22,7 +22,7 @@ include one or more tests to ensure that hyper does not regress in the future. ### Commits Once code, tests, and documentation have been written, a commit needs to be -made. Following the [commit guidelines](COMMITS.md) will help with the review +made. Following the [commit guidelines](commits.md) will help with the review process by making your change easier to understand, and makes it easier for hyper to produce a valuable changelog with each release. diff --git a/_contrib/tenets.md b/_contrib/tenets.md index a9d0f29..d5e56c1 100644 --- a/_contrib/tenets.md +++ b/_contrib/tenets.md @@ -20,11 +20,9 @@ community building and using it. All contributions are in the open. We don't maintain private versions, and don't include features that aren't useful to others. -[We prioritize kindness][CONDUCT], compassion and empathy towards all +[We prioritize kindness](./code_of_conduct.md), compassion and empathy towards all contributors. Technical skill is not a substitute for human decency. -[CONDUCT]: https://github.com/hyperium/hyper/blob/master/docs/CODE_OF_CONDUCT.md - ### Examples It's not usually hard for an open source library to stay open and also meet its diff --git a/_contrib/vision.md b/_contrib/vision.md index 5413e9b..76a3241 100644 --- a/_contrib/vision.md +++ b/_contrib/vision.md @@ -28,7 +28,7 @@ that come later (but every case is different). 4. Flexible 5. Understandable -There's a lot more detail about each in [TENETS](./TENETS.md). +There's a lot more detail about each in [TENETS](./tenets.md). ## Use Cases