Add getting started to CONTRIBUTING.md#3287
Open
HarHarLinks wants to merge 4 commits into
Open
Conversation
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
HarHarLinks
added
the
meta
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Deploying matrix-website with
|
| Latest commit: |
82d1848
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://c7b16b91.matrix-website.pages.dev |
| Branch Preview URL: | https://harharlinks-start-contributi.matrix-website.pages.dev |
Contributor
awtj8o81ryywg793
left a comment
awtj8o81ryywg793
left a comment
There was a problem hiding this comment.
Here's a few suggestions.
Co-authored-by: Jack S. <181536874+awtj8o81ryywg793@users.noreply.github.com> Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Contributor
Author
|
Thanks a lot, that's much better! |
Contributor
|
Quoted from a previous comment:
No problem! I think I might be able to address your concern about length (at least to some extent). Let me work on it for a bit. |
Comment on lines
+14
to
+18
| - Making sure the content is up to date - opening issues to highlight out-of-date content is a great help! | ||
| - Writing new documentation - there are constantly new developments and insights around Matrix. If you feel knowledgeable about a topic, consider adding to our `/docs`! | ||
| - Illustrations - a picture can be worth a thousand words! There are many places on the website that benefit from keeping illustrations up to date, or creating new ones! | ||
| - Design - matrix.org has a lot of content, so we need to make sure it's well structured and easy to navigate. We also want it to look nice, inviting, and exciting. If you have ideas about the design, reach out to us! | ||
| - Responsiveness and accessibility - the information on this website is for everyone, whether they use a big PC monitor, a vertical smartphone screen, or a screen reader. We are always open to feedback and insights on how we can improve in this area. |
Contributor
There was a problem hiding this comment.
Suggested change
| - Making sure the content is up to date - opening issues to highlight out-of-date content is a great help! | |
| - Writing new documentation - there are constantly new developments and insights around Matrix. If you feel knowledgeable about a topic, consider adding to our `/docs`! | |
| - Illustrations - a picture can be worth a thousand words! There are many places on the website that benefit from keeping illustrations up to date, or creating new ones! | |
| - Design - matrix.org has a lot of content, so we need to make sure it's well structured and easy to navigate. We also want it to look nice, inviting, and exciting. If you have ideas about the design, reach out to us! | |
| - Responsiveness and accessibility - the information on this website is for everyone, whether they use a big PC monitor, a vertical smartphone screen, or a screen reader. We are always open to feedback and insights on how we can improve in this area. | |
| - Keeping content updated and writing new documentation — please open issues to flag up out-of-date content. If you have the required expertise, help us update existing content and expand our `/docs`. | |
| - Keeping illustrations up to date and creating new ones — a picture can be worth a thousand words. Many parts of the website benefit from refreshed or new illustrations. | |
| - Ensuring accessibility and good design — the website contains a lot of content, so it needs to be well structured, easy to navigate, and visually engaging. Information should be accessible to everyone, whether they use a large PC monitor, a vertical smartphone screen, or a screen reader. If you have ideas, feedback or insights, please get in touch. |
|
|
||
| Join [#matrix.org-website:matrix.org](https://matrix.to/#/%23matrix.org-website%3Amatrix.org) to reach out! | ||
|
|
||
| Here are 3 simple steps to get started submitting PRs: |
Contributor
There was a problem hiding this comment.
Suggested change
| Here are 3 simple steps to get started submitting PRs: | |
| Here are a few simple steps to help you get started with submitting a pull request (PR): |
| Here are 3 simple steps to get started submitting PRs: | ||
|
|
||
| 1. Check out our contributing docs - you're already here, just continue on reading! | ||
| We also recommend skimming our README for some tips in dealing with the repo and how to test your changes locally, |
Contributor
There was a problem hiding this comment.
Suggested change
| We also recommend skimming our README for some tips in dealing with the repo and how to test your changes locally, | |
| We also recommend reading our [README.md](./README.md) for tips on working with the repository and testing your changes locally, |
| We also recommend skimming our README for some tips in dealing with the repo and how to test your changes locally, | ||
| and our [CONTENT.md](./CONTENT.md) for further help on how to work on specific parts of the website. | ||
| See our documentation [below](#review--publishing-policy) about our expectations and what you can expect in return. | ||
| 1. Share your idea first - see [How we take decisions](#how-we-take-decisions). |
Contributor
There was a problem hiding this comment.
Suggested change
| 1. Share your idea first - see [How we take decisions](#how-we-take-decisions). | |
| 1. Share your idea first - for more information, please read about [how we take decisions](#how-we-take-decisions). |
| See our documentation [below](#review--publishing-policy) about our expectations and what you can expect in return. | ||
| 1. Share your idea first - see [How we take decisions](#how-we-take-decisions). | ||
| 1. Pick an issue and submit a PR! | ||
| We maintain several labels on our issues to make it easier to find one that suits you. |
Contributor
There was a problem hiding this comment.
Suggested change
| We maintain several labels on our issues to make it easier to find one that suits you. | |
| We use several labels to make it easier to find an issue that suits you. |
| 1. Share your idea first - see [How we take decisions](#how-we-take-decisions). | ||
| 1. Pick an issue and submit a PR! | ||
| We maintain several labels on our issues to make it easier to find one that suits you. | ||
| The [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we actively think are easy to tackle by outside contributors, |
Contributor
There was a problem hiding this comment.
Suggested change
| The [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we actively think are easy to tackle by outside contributors, | |
| The [`help wanted`](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we consider easy for outside contributors to tackle, |
| 1. Pick an issue and submit a PR! | ||
| We maintain several labels on our issues to make it easier to find one that suits you. | ||
| The [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we actively think are easy to tackle by outside contributors, | ||
| and we have [good first issue](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) for those that are particularly suited to get started. |
Contributor
There was a problem hiding this comment.
Suggested change
| and we have [good first issue](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) for those that are particularly suited to get started. | |
| and we have [`good first issue`](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) for those that are particularly well suited for new contributors. |
| We maintain several labels on our issues to make it easier to find one that suits you. | ||
| The [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we actively think are easy to tackle by outside contributors, | ||
| and we have [good first issue](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) for those that are particularly suited to get started. | ||
| The label [needs decision](https://github.com/matrix-org/matrix.org/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22needs%20decision%22) marks issues that first need further input from the maintainers before considered ready to implement. |
Contributor
There was a problem hiding this comment.
Suggested change
| The label [needs decision](https://github.com/matrix-org/matrix.org/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22needs%20decision%22) marks issues that first need further input from the maintainers before considered ready to implement. | |
| The [`needs decision`](https://github.com/matrix-org/matrix.org/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22needs%20decision%22) label indicates issues that require further input from maintainers before they can be addressed. |
Comment on lines
+9
to
+10
| Contributions to this repository are welcome. We try to make it easy for newcomers and infrequent contributors to help! | ||
| Please let the maintainers know when something is unclear. |
Contributor
There was a problem hiding this comment.
Suggested change
| Contributions to this repository are welcome. We try to make it easy for newcomers and infrequent contributors to help! | |
| Please let the maintainers know when something is unclear. | |
| Contributions to this repository are welcome. We aim to make it easy for newcomers and infrequent contributors to help. Please let the maintainers know if anything is unclear. |
| 1. Check out our contributing docs - you're already here, just continue on reading! | ||
| We also recommend skimming our README for some tips in dealing with the repo and how to test your changes locally, | ||
| and our [CONTENT.md](./CONTENT.md) for further help on how to work on specific parts of the website. | ||
| See our documentation [below](#review--publishing-policy) about our expectations and what you can expect in return. |
Contributor
There was a problem hiding this comment.
Suggested change
| See our documentation [below](#review--publishing-policy) about our expectations and what you can expect in return. | |
| See our review and publishing [documentation](#review--publishing-policy) for more information about our expectations and what you can expect in return. |
Comment on lines
+30
to
+33
| We maintain several labels on our issues to make it easier to find one that suits you. | ||
| The [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we actively think are easy to tackle by outside contributors, | ||
| and we have [good first issue](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) for those that are particularly suited to get started. | ||
| The label [needs decision](https://github.com/matrix-org/matrix.org/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22needs%20decision%22) marks issues that first need further input from the maintainers before considered ready to implement. |
Contributor
There was a problem hiding this comment.
Suggested change
| We maintain several labels on our issues to make it easier to find one that suits you. | |
| The [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) label is for issues we actively think are easy to tackle by outside contributors, | |
| and we have [good first issue](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) for those that are particularly suited to get started. | |
| The label [needs decision](https://github.com/matrix-org/matrix.org/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22needs%20decision%22) marks issues that first need further input from the maintainers before considered ready to implement. | |
| We use several labels to make it easier to find an issue that suits you: | |
| - [help wanted](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22help%20wanted%22) - issues we consider easy for outside contributors to tackle. | |
| - [good first issue](https://github.com/matrix-org/matrix.org/issues?q=state%3Aopen%20label%3A%22good%20first%20issue%22) - issues that are particularly well suited for new contributors. | |
| - [needs decision](https://github.com/matrix-org/matrix.org/issues?q=is%3Aissue%20state%3Aopen%20label%3A%22needs%20decision%22) - issues that require further input from maintainers before they can be addressed. | |
Contributor
|
Let me know which approach you want to take with the list of labels. I'll do another review once we've settled on a path forward. |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
The idea is to point out what kind of help we're looking for, and summarising the essentials one should know to get going.
My biggest concern is this being too long again, as usual.
Related issues
Role
Website & Content WG.
Timeline
Signoff
Please sign off your individual commits or whole pull request.