-
Notifications
You must be signed in to change notification settings - Fork 33
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
Update README.md #68
Conversation
There was a problem hiding this 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.
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- 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. |
That is unfortunately not possible at the moment. |
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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
How about:
- 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Co-authored-by: Dipika Bhattacharya <dipika@foss-community.org>
Thank you for all of the great suggestions @dipikabh! |
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. |
Adds a table with a detailed explanation of the intent of each category.