Add remark + preset and auto-format docs

.github/CODE_OF_CONDUCT.md

@@ -2,45 +2,60 @@
 
 ## Our Pledge
 
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making
+participation in our project and our community a harassment-free experience for everyone, regardless of age, body size,
+disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
 
 ## Our Standards
 
 Examples of behavior that contributes to creating a positive environment include:
 
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
+- The use of sexualized language or imagery and unwelcome sexual attention or advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a professional setting
 
 ## Our Responsibilities
 
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take
+appropriate and fair corrective action in response to any instances of unacceptable behavior.
 
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits,
+issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any
+contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
 
 ## Scope
 
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the
+project or its community. Examples of representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed representative at an online or offline
+event. Representation of a project may be further defined and clarified by project maintainers.
 
 ## Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at lars@webpro.nl. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at
+[lars@webpro.nl][1]. The project team will review and investigate all complaints, and will respond in a way that it
+deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the
+reporter of an incident. Further details of specific enforcement policies may be posted separately.
 
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent
+repercussions as determined by other members of the project's leadership.
 
 ## Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at
+[http://contributor-covenant.org/version/1/4][version]
 
+[1]: mailto:lars@webpro.nl
 [homepage]: http://contributor-covenant.org
 [version]: http://contributor-covenant.org/version/1/4/

.github/CONTRIBUTING.md

@@ -6,8 +6,8 @@ Following these guidelines helps to communicate that you respect the time of the
 source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping
 you finalize your pull requests.
 
-This project has a [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating in this project you
-agree to abide by its terms.
+This project has a [Contributor Covenant Code of Conduct][1]. By participating in this project you agree to abide by its
+terms.
 
 ## ❤️ Ways to Contribute
 
@@ -20,19 +20,17 @@ agree to abide by its terms.
 
 ## 🛎 Questions & Feature Requests
 
-Feel free to [open a ticket](https://github.com/release-it/release-it/issues/new) with your question. Feature requests
-are also welcome. Describe the feature, why you need it, and how it should work. Please provide as much detail and
-context as possible.
+Feel free to [open a ticket][2] with your question. Feature requests are also welcome. Describe the feature, why you
+need it, and how it should work. Please provide as much detail and context as possible.
 
 ## 🐛 File a Bug
 
 In case you've encountered a bug, please make sure:
 
-- You are using the [latest version](https://github.com/release-it/release-it/releases).
-- You have read the [documentation](https://github.com/release-it/release-it/blob/main/README.md) first, and
-  double-checked your configuration.
-- You have acknowledged from [Troubleshooting & debugging](../README.md#troubleshooting--debugging) the errors are
-  likely a bug in this project, and not coming from e.g. your environment or custom scripts/commands.
+- You are using the [latest version][3].
+- You have read the [documentation][4] first, and double-checked your configuration.
+- You have acknowledged from [Troubleshooting & debugging][5] the errors are likely a bug in this project, and not
+  coming from e.g. your environment or custom scripts/commands.
 - In your issue description, please include:
   - What you expected to see, and what happened instead.
   - Your operating system and other environment information.
@@ -44,21 +42,20 @@ In case you've encountered a bug, please make sure:
 
 Pull requests are welcome! If you never created a pull request before, here are some tutorials:
 
-- [Creating a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
-- [How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
+- [Creating a pull request][6]
+- [How to Contribute to an Open Source Project on GitHub][7]
 
 Please keep the following in mind:
 
 - To match the existing code styling, use `npm run format` before committing code.
 - Make sure the tests pass (run `npm test`). Your changes probably deserve new tests as well.
 - Remember that this project is cross-platform compatible (macOS, Windows, Linux), and that it runs in different
-  versions of Node. On PR submission, a [GitHub Action](https://github.com/release-it/release-it/actions) will run the
-  tests in multiple supported platforms and Node.js versions.
+  versions of Node. On PR submission, a [GitHub Action][8] will run the tests in multiple supported platforms and
+  Node.js versions.
 
 Unsure about whether you should open a pull request? Feel free to discuss it first in a ticket.
 
-[Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository to get started, and set it up on
-your machine:
+[Fork][9] the repository to get started, and set it up on your machine:
 
 ```bash
 git clone https://github.com/<your-github-username>/release-it
@@ -72,7 +69,7 @@ Verify the tests are passing:
 npm test
 ```
 
-To use your modified version of release-it in your project, [npm-link](https://docs.npmjs.com/cli/link.html) it:
+To use your modified version of release-it in your project, [npm-link][10] it:
 
 ```bash
 # From your release-it clone:
@@ -81,3 +78,15 @@ npm link
 # From your project that uses release-it:
 npm link release-it
 ```
+
+[1]: ./CODE_OF_CONDUCT.md
+[2]: https://github.com/release-it/release-it/issues/new
+[3]: https://github.com/release-it/release-it/releases
+[4]: https://github.com/release-it/release-it/blob/main/README.md
+[5]: ../README.md#troubleshooting--debugging
+[6]:
+  https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
+[7]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
+[8]: https://github.com/release-it/release-it/actions
+[9]: https://docs.github.com/en/get-started/quickstart/fork-a-repo
+[10]: https://docs.npmjs.com/cli/link.html