Skip to content

Commit

Permalink
Merge pull request #50 from systemphil/chore/pr-template3
Browse files Browse the repository at this point in the history
refactor: streamline checklist
  • Loading branch information
Firgrep authored Jul 10, 2024
2 parents 553955c + 09860d9 commit 030dd8b
Showing 1 changed file with 16 additions and 47 deletions.
63 changes: 16 additions & 47 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,16 @@
Thank you for wanting to contribute to sPhil! 🧙 🦉
<!-- Please put your own text under the second heading below, AFTER the checklist -->

We would like to keep our code and writing as neat and tidy as possible, and would appreciate if you could verify the following.
Thank you for wanting to contribute to sPhil! 🧙 🦉

Each PR should _either_ contribute content or functional code.
We would like to keep our code and writing as neat and tidy as possible, and would appreciate if you could verify the following. Each PR should _either_ contribute content or functional code.

## Checklist (pick `Docs` or `Code`)

🚩`REQUIRED`

<!-- put `x` inside of the brackets to click the check marks after you've opened your PR -->

- [ ] Docs contribution (philosophy, literature, content)
- [ ] 🚩 I accept that my writing is submitted under the [ATTRIBUTION-NONCOMMERCIAL-SHAREALIKE 4.0 INTERNATIONAL](https://creativecommons.org/licenses/by-nc-sa/4.0/), which, briefly put, prohibits commercial re-use of the content, but allows sharing, remixing and building upon the material insofar as attribution is given (see [legal code](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.en)), and in this regard I understand that my writing is open to be modified, remixed and build upon by others in the sPhil community within the `systemphil/sphil` project in future perpetuity.
- [ ] 🚩 I have followed the [formatting guidelines](https://github.com/systemphil/sphil/blob/dev/src/pages/contributing/formatting/basic-markdown.md).
- [ ] 🚩 I have followed the [MLA citation style](https://owl.purdue.edu/owl/research_and_citation/mla_style/mla_formatting_and_style_guide/mla_formatting_and_style_guide.html).
- [ ] 🚩 I have added or verified title and description metadata.
<details>
<summary>
See example 📜
</summary>
- [ ] **REQUIRED** I accept that my writing is submitted under the [ATTRIBUTION-NONCOMMERCIAL-SHAREALIKE 4.0 INTERNATIONAL](https://creativecommons.org/licenses/by-nc-sa/4.0/), which, briefly put, prohibits commercial re-use of the content, but allows sharing, remixing and building upon the material insofar as attribution is given (see [legal code](https://creativecommons.org/licenses/by-nc-sa/4.0/legalcode.en)), and in this regard I understand that my writing is open to be modified, remixed and build upon by others in the sPhil community within the `systemphil/sphil` project in future perpetuity.
- [ ] **REQUIRED** I have followed the [formatting guidelines](https://github.com/systemphil/sphil/blob/dev/src/pages/contributing/formatting/basic-markdown.md).
- [ ] **REQUIRED** I have followed the [MLA citation style](https://owl.purdue.edu/owl/research_and_citation/mla_style/mla_formatting_and_style_guide/mla_formatting_and_style_guide.html).
- [ ] **REQUIRED** I have added or verified title and description metadata at the very top of the file. Example:

```md
---
Expand All @@ -27,29 +19,15 @@ Each PR should _either_ contribute content or functional code.
---
```

</details>
- [ ] My article is a stub or I want to actively encourage contribution, I've added the Stub component:
<details>
<summary>
See example 🌿
</summary>

Add this to the bottom of your content but _before_ the bibliography.
- [ ] My article is a stub or I want to actively encourage contribution, I've added the Stub component to the bottom of my content but _before_ the bibliography:

```ts
import Stub from "@/components/Stub";

<Stub />
```

</details>
- [ ] 🚩 I have added, verified or extended a bibliography.
<details>
<summary>
See example 📚
</summary>

Add this before the authors section. Please make sure to follow MLA guidelines regarding bibliography.
- [ ] **REQUIRED** I have added, verified or extended a bibliography. This is added before the authors section and follows MLA guidelines. Example:

```mdx
## Works Cited
Expand All @@ -60,18 +38,12 @@ Each PR should _either_ contribute content or functional code.
</div>
```

</details>

- [ ] I have signed the document with my name/username under either as `Authors`, `Editors` or `Contributors`.
<details>
<summary>
See example ✒️
</summary>

- Use **Authors** if you have created and substantially added content.
- Use **Editor** if you have made substantial edits or review.
- Use **Contributor** if you have made minor edits, reviews or contributions.
- If you've done multiple, pick the most weighted: Author > Editor > Contributor.
> Use **Authors** if you have created and substantially added content.
Use **Editor** if you have made substantial edits or review.
Use **Contributor** if you have made minor edits, reviews or contributions.
If you've done multiple, pick the most weighted: Author > Editor > Contributor.
If you prefer to remain anonymous, that's fine too, but note that a record of your contributions based on your GitHub username will exist here in the codebase.

```md

Expand All @@ -86,10 +58,7 @@ Each PR should _either_ contribute content or functional code.
Filip Niklas (2024), Boromir (2025)
```

If you prefer to remain anonymous, that's fine too, but note that a record of your contributions based on your GitHub username will exist here in the codebase.

</details>
- [ ] If the article makes use of footnotes, I have checked that `**Notes**` is exactly the very last item in the article.
- [ ] If the article makes use of footnotes, I have checked that `**Notes**` is exactly the very last item in the file.


- [ ] Code contribution ([Apache version 2 license](https://www.apache.org/licenses/LICENSE-2.0.txt))
Expand All @@ -99,6 +68,6 @@ Each PR should _either_ contribute content or functional code.

</details>

---
## PR Author's Note

<!-- Write your PR text here -->

0 comments on commit 030dd8b

Please sign in to comment.