Skip to content

Add getting started to CONTRIBUTING.md#3287

Open
HarHarLinks wants to merge 7 commits into
mainfrom
HarHarLinks/start-contributing
Open

Add getting started to CONTRIBUTING.md#3287
HarHarLinks wants to merge 7 commits into
mainfrom
HarHarLinks/start-contributing

Conversation

@HarHarLinks

Copy link
Copy Markdown
Contributor

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.

Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
@HarHarLinks HarHarLinks requested a review from a team as a code owner March 18, 2026 13:13
@HarHarLinks HarHarLinks added the meta Something concerning the repo itself, such as technical changes, contribution guidelines, and more. label Mar 18, 2026
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Mar 18, 2026

Copy link
Copy Markdown

Deploying matrix-website with  Cloudflare Pages  Cloudflare Pages

Latest commit: 82354b7
Status: ✅  Deploy successful!
Preview URL: https://13fccd09.matrix-website.pages.dev
Branch Preview URL: https://harharlinks-start-contributi.matrix-website.pages.dev

View logs

Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>

@awtj8o81ryywg793 awtj8o81ryywg793 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here's a few suggestions.

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Co-authored-by: Jack S. <181536874+awtj8o81ryywg793@users.noreply.github.com>
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
@HarHarLinks

Copy link
Copy Markdown
Contributor Author

Thanks a lot, that's much better!

@awtj8o81ryywg793

awtj8o81ryywg793 commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Quoted from a previous comment:

Thanks a lot, that's much better!

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.

@awtj8o81ryywg793 awtj8o81ryywg793 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Here's some further comments. Just a slight shortening (of the "How to start contributing" list) and a general tidy‑up. I don't think the length is much of an issue here.

Comment thread CONTRIBUTING.md
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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

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.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

i chose to list more but simpler examples here with the idea that it would be easier to spot aspects where one could help. is that a bad idea?

Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md Outdated
Comment thread CONTRIBUTING.md
Comment thread CONTRIBUTING.md Outdated

@awtj8o81ryywg793 awtj8o81ryywg793 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Instead of the linked suggestions below, what about using a list instead? I think using a list improves readability and can hopefully mitigate any concerns you have regarding length.

Comment thread CONTRIBUTING.md Outdated
@awtj8o81ryywg793

Copy link
Copy Markdown
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.

HarHarLinks and others added 2 commits June 27, 2026 16:38
Co-authored-by: Jack S. <181536874+awtj8o81ryywg793@users.noreply.github.com>
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Co-authored-by: Jack S. <181536874+awtj8o81ryywg793@users.noreply.github.com>
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Comment thread CONTRIBUTING.md Outdated
Signed-off-by: Kim Brose <2803622+HarHarLinks@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

meta Something concerning the repo itself, such as technical changes, contribution guidelines, and more.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants