Skip to content

Commit

Permalink
Refactor prose, issue templates, discussions
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Aug 22, 2020
1 parent b291f50 commit 843c773
Show file tree
Hide file tree
Showing 9 changed files with 43 additions and 42 deletions.
8 changes: 4 additions & 4 deletions .github/ISSUE_TEMPLATE/1-bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ labels: 🔍 status/open, 🐛 type/bug
---

<!--
Ouch, sorry you’ve run into a bug. Thank for taking the time to report it!
Ouch, sorry you ran into a bug. Thank for taking the time to report it!
Please fill in as much of the template below as you’re able.
Expand All @@ -18,7 +18,7 @@ https://github.com/remarkjs/.github/blob/main/contributing.md

Describe your issue here.

This is *not* a place to ask questions. For that, go to [spectrum](https://spectrum.chat/unified/remark)
This is *not* a place to ask questions. For that, go to [discussions](https://github.com/remarkjs/remark/discussions)

### Your environment

Expand All @@ -32,10 +32,10 @@ Tell us how to reproduce this issue. Please provide a working and simplified ex

🎉 BONUS POINTS for creating a [minimal reproduction](https://stackoverflow.com/help/mcve) and uploading it to GitHub. This will get you the fastest support. 🎉

### Expected behaviour
### Expected behavior

What should happen?

### Actual behaviour
### Actual behavior

What happens instead?
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/2-feature.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ Describe your issue here.

If the feature requests relates to a problem, please describe the problem you are trying to solve here.

### Expected behaviour
### Expected behavior

What should happen? Please describe the desired behaviour.
What should happen? Please describe the desired behavior.

### Alternatives

Expand Down
10 changes: 0 additions & 10 deletions .github/ISSUE_TEMPLATE/3-help.md

This file was deleted.

5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 🙋 Ask a question
url: https://github.com/remarkjs/remark/discussions
about: Ask questions and discuss with other community members
4 changes: 2 additions & 2 deletions code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,8 +74,8 @@ In cases where community members transgress against the values in the code of
conduct, members of the moderation team will use a three-strike warning system,
where the aggressor will be warned twice before they are permanently excluded
from our community spaces.
This code applies to GitHub, Spectrum, Twitter, and any other space that this
community uses for communication.
This code applies to GitHub, Twitter, and any other space that this community
uses for communication.
For interactions between community members outside of this space, the code also
applies if the interactions are reported and deemed to be interfering with
community members safely working on the collective together.
Expand Down
8 changes: 4 additions & 4 deletions contributing.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Contributing

> This project has a [Code of Conduct][coc].
> By interacting with this repository, organisation, or community you agree to
> This project has a [code of conduct][coc].
> By interacting with this repository, organization, or community you agree to
> abide by its terms.
Hi! 👋
Expand All @@ -13,7 +13,7 @@ If you’re raising an issue, please understand that people involved with this
project often do so for fun, next to their day job; you are not entitled to
free customer service.

## Table of Contents
## Contents

* [Ecosystem](#ecosystem)
* [Contributions](#contributions)
Expand All @@ -30,7 +30,7 @@ free customer service.

## Ecosystem

The collective ([unified][]) consists of several organisations and separate
The collective ([unified][]) consists of several organizations and separate
projects: most of them are tiny, and many of them have a utility
([`mdast-util-to-hast`][mdast-util-to-hast]), a plugin
([`remark-rehype`][remark-rehype]), and relate to an ecosystem
Expand Down
8 changes: 4 additions & 4 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# `.github`

Community health files for **remark**.
This repo hosts the [Code of Conduct][coc], a guide on how to get [support][],
This repo hosts the [code of conduct][coc], a guide on how to get [support][],
how to [contribute][], a [pull request template][pr], and [issue
templates][issue].

Expand All @@ -26,10 +26,10 @@ Take a moment to read [`contributing.md`][contribute].

Ideas for new plugins and tools can be posted in [`remarkjs/ideas`][ideas].

## Code of Conduct
## Code of conduct

This project has a [Code of Conduct][coc].
By interacting with this repository, organisation, or community you agree to
This project has a [code of conduct][coc].
By interacting with this repository, organization, or community you agree to
abide by its terms.

## License
Expand Down
6 changes: 3 additions & 3 deletions security.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ website governed by remark, we encourage you to notify us.

Projects governed by remark sometimes do unsafe things by design (such as a
plugin that executes arbitrary code or an option that is dangerous).
This unsafe behaviour should be explicitly documented and, if it is, is not
This unsafe behavior should be explicitly documented and, if it is, is not
considered a security issue.

There are no hard and fast rules to determine if a bug is worth reporting as a
Expand All @@ -33,9 +33,9 @@ You will receive a more detailed response within 96 hours.
We will create a maintainer security advisory on GitHub to discuss internally,
and when needed, invite you to the advisory.

## Safe harbour
## Safe harbor

**remark** supports safe harbour for security researchers who:
**remark** supports safe harbor for security researchers who:

* Make a good faith effort to avoid privacy violations, destruction of data,
and interruption or degradation of our services
Expand Down
32 changes: 19 additions & 13 deletions support.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Support

> This project has a [Code of Conduct][coc].
> By interacting with this repository, organisation, or community you agree to
> This project has a [code of conduct][coc].
> By interacting with this repository, organization, or community you agree to
> abide by its terms.
Hi! 👋
Expand All @@ -11,7 +11,7 @@ To help us help you, please read through the following guidelines.
Please understand that people involved with this project often do so for fun,
next to their day job; you are not entitled to free customer service.

## Table of Contents
## Contents

* [Questions](#questions)
* [Asking quality questions](#asking-quality-questions)
Expand All @@ -20,24 +20,28 @@ next to their day job; you are not entitled to free customer service.

## Questions

Please chat and ask questions on [spectrum][chat]!
Please chat and ask questions on [Discussions][chat]!
Jump in there and lurk, talk to us, and help others.

* [**unified**](https://spectrum.chat/unified/unified)
* [**unified**](https://github.com/unifiedjs/unified/discussions)
— Topics relating to [**unified**][unified] in general
* [**vfile**](https://spectrum.chat/unified/vfile)
— Topics relating to [**vfile**][vfile]: virtual files
* [**syntax-tree**](https://spectrum.chat/unified/syntax-tree)
— Topics relating to [**syntax-tree**][syntax-tree] and [**unist**][unist]
* [**remark**](https://spectrum.chat/unified/remark)
* [**remark**](https://github.com/remarkjs/remark/discussions)
— Topics relating to the [**remark**][remark] ecosystem, markdown,
and [**mdast**][mdast]
* [**rehype**](https://spectrum.chat/unified/rehype)
* [**rehype**](https://github.com/rehypejs/rehype/discussions)
— Topics relating to the [**rehype**][rehype] ecosystem, HTML,
and [**hast**][hast]
* [**retext**](https://spectrum.chat/unified/retext)
* [**retext**](https://github.com/retextjs/retext/discussions)
— Topics relating to the [**retext**][retext] ecosystem, natural language,
and [**nlcst**][nlcst]
* [**MDX**](https://github.com/mdx-js/mdx/discussions)
— Topics relating to [**MDX**][mdx]
* [**micromark**](https://github.com/micromark/micromark/discussions)
— Topics relating to the future of markdown in unified!
* [**vfile**](https://github.com/vfile/vfile/discussions)
— Topics relating to [**vfile**][vfile]: virtual files
* [**syntax-tree**](https://github.com/syntax-tree/unist/discussions)
— Topics relating to [**syntax-tree**][syntax-tree] and [**unist**][unist]

### Asking quality questions

Expand Down Expand Up @@ -99,12 +103,14 @@ See [`contributing.md`][contributing] on how to contribute.

[rehype]: https://github.com/rehypejs/rehype

[mdx]: https://github.com/mdx-js/mdx

[rubberduck]: https://rubberduckdebugging.com

[xy]: https://meta.stackexchange.com/questions/66377/what-is-the-xy-problem/66378#66378

[codesandbox]: https://codesandbox.io

[chat]: https://spectrum.chat/unified
[chat]: https://github.com/remarkjs/remark/discussions

[contributing]: contributing.md

0 comments on commit 843c773

Please sign in to comment.