Skip to content

Commit

Permalink
chore: Add project template files (#24)
Browse files Browse the repository at this point in the history
* chore: Add repo templates

* chore: Add CONTRIBUTING.md

* feat: Add codeowners
  • Loading branch information
bsmth authored Jan 24, 2024
1 parent 5efda9e commit ac2c1c6
Show file tree
Hide file tree
Showing 8 changed files with 82 additions and 4 deletions.
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @mdn/core-yari-content
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Content or feature request
url: https://github.com/mdn/mdn/issues/new/choose
about: Propose new content for MDN Web Docs or submit a feature request using this link.
- name: MDN GitHub Discussions
url: https://github.com/orgs/mdn/discussions
about: Does your topic involve a lot of pages, or are you not sure how it can be split into actionable tasks? Consider starting a discussion first.
15 changes: 15 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!--
Thanks for opening a PR!
If you're adding agenda items, this format helps keep organized:

- Discuss my awesome topic. See [link for more details](https://github.com/mdn/community-meetings/pulls) (@MyUsername)
-->

**Description:**

<!-- ✍️ A brief summary, with background info if necessary. -->

**Additional details:**

<!-- 🔨 If there are issues and pull requests to link to, add them here! -->
<!-- 🔗 Also link to discussions, docs, bug trackers, source control, anything else that provides context. -->
9 changes: 9 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
// This file defines our configuration for Markdownlint. See
// https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md
// for more details on each rule.

{
"default": true,
"line-length": false,
"first-line-h1": false
}
9 changes: 9 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Community Participation Guidelines

This repository is governed by Mozilla's code of conduct and etiquette guidelines.
For more details, please read the
[Mozilla Community Participation Guidelines](https://www.mozilla.org/about/governance/policies/participation/).

## How to Report

For more information on how to report violations of the Community Participation Guidelines, please read our [How to Report](https://www.mozilla.org/about/governance/policies/participation/reporting/) page.
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contribution guide

Thanks for your interest in taking part in MDN community meetings.
This document provides some tips for getting your topics added to the agenda and discussed during calls.

## Adding to the agenda

There are folders for each community call in the format `YY-MM-DD`.
If you want to add something to the agenda, you can open a pull request that suggests to add your item to a future call:

```plain
├── 24-01-22
│   ├── agenda.md <-- Add your topic to `agenda.md` (e.g., January 22nd 2024)
│   └── minutes.md
...
```

You can open a pull request on GitHub by navigating to the `YY-MM-dd/agenda.md` document, and clicking the edit icon.
For more information, see the [GitHub documentation for editing files](https://docs.github.com/en/repositories/working-with-files/managing-files/editing-files).

Make sure you use the following format when you're adding your topic:

```markdown
- Discuss my awesome topic. See [link for more details](https://github.com/mdn/community-meetings/pulls) (@MyUsername)
```

Your pull request should have links to other information in the description field, if necessary.
There are hints in the pull request template that will help guide you on your submission!

## Get in touch

If you get stuck, you can reach out to us in one of our [communication channels](https://developer.mozilla.org/en-US/docs/MDN/Community/Communication_channels).
10 changes: 7 additions & 3 deletions template [COPY]/agenda.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,16 @@

## Team updates

Any project updates from the MDN team
Project updates from the MDN team

## Contributor updates

Any project/work updates from contributors
Project/work updates from contributors

- [example] Progress on my awesome project. See [link for more details](https://github.com/mdn/community-meetings) (@MyUsername)

## Questions/Discussions

Any questions from folks & anything to discuss
Questions from folks & anything to discuss

- [example] Discuss my interesting topic. See [link for more details](https://github.com/mdn/community-meetings) (@MyUsername)
2 changes: 1 addition & 1 deletion template [COPY]/minutes.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
# Minutes from MDN community meeting [insert date here]
# Minutes from MDN community meeting [insert date here]

0 comments on commit ac2c1c6

Please sign in to comment.