Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@ contact_links:
about: GitHub Issue is for tracking problems occurred in our project and not for questions. Please follow SUPPORT.md.
- name: 💬 Discussions
url: https://github.com/marp-team/marp/discussions
about: We recommend using GitHub Discussions for to ask something.
about: We recommend using GitHub Discussions to ask questions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/report-a-bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ body:
value: |
## Before reporting a bug

- This form is for reporting a bug certainly confirmed. If you cannot confident that it is a bug, please ask in [Marp dicussion forum](https://github.com/marp-team/marp/discussions) first. _See also: [Why you must not ask questions on Github issues](https://medium.com/@methane/why-you-must-not-ask-questions-on-github-issues-51d741d83fde)_
- This form is for reporting a bug certainly confirmed. If you cannot confident that it is a bug, please ask in [Marp discussion forum](https://github.com/marp-team/marp/discussions) first. _See also: [Why you must not ask questions on GitHub issues](https://medium.com/@methane/why-you-must-not-ask-questions-on-github-issues-51d741d83fde)_
* Is this repository suited for reporting your issue? We ask for your cooperation to report the issue to corresponding repository based on the cause of bug. _See also: [The architecture of Marp ecosystem](https://github.com/marp-team/.github/blob/master/CONTRIBUTING.md#architecture)_

> Marp team may [transfer the reported issue](https://help.github.com/en/articles/transferring-an-issue-to-another-repository) into the proper repository. If the suited repository is not clear, you also can report to [Marp dicussion forum](https://github.com/marp-team/marp/discussions).
> Marp team may [transfer the reported issue](https://help.github.com/en/articles/transferring-an-issue-to-another-repository) into the proper repository. If the suited repository is not clear, you also can report to [Marp discussion forum](https://github.com/marp-team/marp/discussions).

- type: input
id: version
Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Thank you for taking the time to read how to contribute to our project! This is

You can start contributing our project in several ways: improve docs, report bug, request feature, writing code, and so on.

Depending on the project you want to contribute, it might have additional guidelines you should follow at that repository. Please also check the guideline per repository.
Copy link
Author

Choose a reason for hiding this comment

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

I don't think the sentence I'm removing added any value.

Copy link
Member

Choose a reason for hiding this comment

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

I've added to emphasize existence of repository-specific guideline. If not, some of contributors may miss that.

Copy link
Author

Choose a reason for hiding this comment

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

Depending on the project you want to contribute, it might have additional guidelines you should follow for that repository.
Copy link
Author

Choose a reason for hiding this comment

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

Suggested change
Depending on the project you want to contribute, it might have additional guidelines you should follow for that repository.
If a repository as additional guidelines, please read and follow them.


> :information_source: Would you the first time to contribute OSS? [Open Source Guides](https://opensource.guide/how-to-contribute/) might help you.

Expand All @@ -14,7 +14,7 @@ We follow [Contributor Covenant Code of Conduct][code-of-conduct] in the all of

## Our position

For simplicity and long-maintainabillity of the ecosystem, Marp team is focusing just to the experience of slide authoring.
For simplicity and long-maintainability of the ecosystem, Marp team is focusing just to the experience of slide authoring.
Copy link
Author

Choose a reason for hiding this comment

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

I think this would be better as:

Suggested change
For simplicity and long-maintainability of the ecosystem, Marp team is focusing just to the experience of slide authoring.
For simplicity and long-term maintainability of the ecosystem, Marp team is focusing just to the experience of slide authoring.


Team members should avoid to bring [scope creep] and bloated project scope in the ecosystem. If not, the ecosystem would end up burning out, just like a [former Marp app](https://github.com/yhatt/marp).

Expand Down Expand Up @@ -81,9 +81,9 @@ You can submit pull request if you have fixed or added useful something to our p

### Before adding new feature

_Marp team is not proactive for enhanceing our syntax_, because the custom Markdown flavor may make user's confusions and protests whose are familiar with exist Markdown/CommonMark syntax.
_Marp team is not proactive for enhancing our syntax_, because the custom Markdown flavor may make user's confusions and protests whose are familiar with exist Markdown/CommonMark syntax.

We are always suggesting **"Use or create the third-party [plugin](https://marpit.marp.app/usage?id=extend-marpit-by-plugins) if you want"** rather than adding new syntax. For implementing new syntax and new feature to offical tools, we require able to confirm a worth through a created third-party plugin and many real-world presentations using it. We will consider integrating the plugin as built-in feature if the most of Marp community shows that using the plugin is valuable.
We are always suggesting **"Use or create the third-party [plugin](https://marpit.marp.app/usage?id=extend-marpit-by-plugins) if you want"** rather than adding new syntax. For implementing new syntax and new feature to official tools, we require able to confirm a worth through a created third-party plugin and many real-world presentations using it. We will consider integrating the plugin as built-in feature if the most of Marp community shows that using the plugin is valuable.

### [Good first issues](https://github.com/search?q=org%3Amarp-team+is%3Aopen+label%3A%22good+first+issue%22)

Expand Down
2 changes: 1 addition & 1 deletion SUPPORT.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,6 @@ Or you can use [StackOverflow] if you want to ask something.

Please keep in mind that _GitHub issue tracker is not a support forum_.

In general, GitHub issues is designed for tracking problems occured in project. A personal question will prevent Marp team focusing to resolve core issues. Moreover, users whose same problem will become difficult to find out closed issue.
In general, GitHub issues is designed for tracking problems occurred in project. A personal question will prevent Marp team focusing to resolve core issues. Moreover, users whose same problem will become difficult to find out closed issue.

You should use [GitHub Discussions] instead. If posted questions/discussions into issues in each repositories of marp-team, it would be tagged as [`question` label](https://github.com/search?q=org%3Amarp-team+label%3Aquestion&type=Issues) and even closed in early.