Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #68

Merged
merged 17 commits into from
May 11, 2022
Merged

Update README.md #68

merged 17 commits into from
May 11, 2022

Conversation

schalkneethling
Copy link

Adds a table with a detailed explanation of the intent of each category.

@schalkneethling schalkneethling added the enhancement New feature or request label May 10, 2022
Copy link
Contributor

@dipikabh dipikabh left a comment

Choose a reason for hiding this comment

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

Thanks @schalkneethling for this important addition! 👍

Is it in any way possible to have this table right on the discussions page? (also this readme is getting too long with a lot of important messages). It might be more efficient to have the table on the discussions page to avoid toggling with this page to see the definitions.
Better still, can each category on the discussions page have a statement describing the intent of the category - that will make the contributors stop and think if they're in the right place even if they've missed to check this table of definitions.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
On MDN Web Docs, we encourage our community to have healthy discussions around topics related to the overall project. We ask that you keep each discussion on topic and not open discussions covering various issues or topics. MDN Web Docs discussions are also not the place to report problems. For issues, it is best to raise them against the [relevant project](https://github.com/mdn/). If you are ever in doubt, consider the following:

- Issues are to report a bug or a topic with a clearly defined and actionable outcome.
- If the issue needs a discussion to agree upon a course of action or define an actionable piece of work, you are in the right place.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- If the issue needs a discussion to agree upon a course of action or define an actionable piece of work, you are in the right place.
- If the issue needs a discussion to agree upon a course of action or to define an actionable piece of work, you are right to initiate a discussion.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@schalkneethling
Copy link
Author

It might be more efficient to have the table on the discussions page to avoid toggling with this page to see the definitions.

That is unfortunately not possible at the moment.

Schalk Neethling and others added 9 commits May 10, 2022 19:44
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
_NOTE:_ mdn-community/discussions is not the place to report problems. For content-related probelms you come across on MDN Web Docs, it is best to raise issues against the [relevant project](https://github.com/mdn/). If you're ever in doubt about whether to open an issue or a discussion, consider the following guidelines:

- Issues are for reporting a bug with a clearly defined and actionable outcome.
- If the issue needs a discussion to agree upon a course of action or define an actionable piece of work, you are in the right place.
Copy link
Author

Choose a reason for hiding this comment

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

How about:

Suggested change
- If the issue needs a discussion to agree upon a course of action or define an actionable piece of work, you are in the right place.
- If the issue needs a discussion to agree upon a course of action or to define an actionable piece of work, you are in the right place to initiate a discussion.

Copy link
Contributor

Choose a reason for hiding this comment

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

Looks good

README.md Outdated Show resolved Hide resolved
Schalk Neethling and others added 3 commits May 10, 2022 19:51
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
@schalkneethling
Copy link
Author

Thank you for all of the great suggestions @dipikabh!

@schalkneethling
Copy link
Author

can each category on the discussions page have a statement describing the intent of the category

You can have short blurbs, but nothing as long as we have here. I believe the intent is to have a place to point people to should we need to clarify. If people end up reading it beforehand, that is a bonus. Once this is merged, we can post an announcement and pin it to the discussions page.

Something like, "Please read this before starting a discussion" as the subject line.

@dipikabh dipikabh merged commit 1b1c4c9 into mdn:main May 11, 2022
@schalkneethling schalkneethling deleted the update-readme-with-category-details branch May 11, 2022 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants