Skip to content

Commit 608edf8

Browse files
committed
chore: set prettier prose wrap to always for md
1 parent ef6c795 commit 608edf8

File tree

24 files changed

+924
-410
lines changed

24 files changed

+924
-410
lines changed

.prettierrc

+1-2
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,9 @@
77
{
88
"files": "*.md",
99
"options": {
10-
"printWidth": 70,
1110
"useTabs": false,
1211
"trailingComma": "none",
13-
"proseWrap": "never"
12+
"proseWrap": "always"
1413
}
1514
}
1615
]

CODE_OF_CONDUCT.md

+53-19
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,14 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a
6+
harassment-free experience for everyone, regardless of age, body size, visible or invisible
7+
disability, ethnicity, sex characteristics, gender identity and expression, level of experience,
8+
education, socio-economic status, nationality, personal appearance, race, religion, or sexual
9+
identity and orientation.
610

7-
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
11+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and
12+
healthy community.
813

914
## Our Standards
1015

@@ -13,67 +18,96 @@ Examples of behavior that contributes to a positive environment for our communit
1318
- Demonstrating empathy and kindness toward other people
1419
- Being respectful of differing opinions, viewpoints, and experiences
1520
- Giving and gracefully accepting constructive feedback
16-
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
21+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the
22+
experience
1723
- Focusing on what is best not just for us as individuals, but for the overall community
1824

1925
Examples of unacceptable behavior include:
2026

2127
- The use of sexualized language or imagery, and sexual attention or advances of any kind
2228
- Trolling, insulting or derogatory comments, and personal or political attacks
2329
- Public or private harassment
24-
- Publishing others' private information, such as a physical or email address, without their explicit permission
30+
- Publishing others' private information, such as a physical or email address, without their
31+
explicit permission
2532
- Other conduct which could reasonably be considered inappropriate in a professional setting
2633

2734
## Enforcement Responsibilities
2835

29-
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
36+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior
37+
and will take appropriate and fair corrective action in response to any behavior that they deem
38+
inappropriate, threatening, offensive, or harmful.
3039

31-
Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
40+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits,
41+
code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and
42+
will communicate reasons for moderation decisions when appropriate.
3243

3344
## Scope
3445

35-
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
46+
This Code of Conduct applies within all community spaces, and also applies when an individual is
47+
officially representing the community in public spaces. Examples of representing our community
48+
include using an official e-mail address, posting via an official social media account, or acting as
49+
an appointed representative at an online or offline event.
3650

3751
## Enforcement
3852

39-
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
53+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community
54+
leaders responsible for enforcement at [email protected]. All complaints will be reviewed and
55+
investigated promptly and fairly.
4056

41-
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
57+
All community leaders are obligated to respect the privacy and security of the reporter of any
58+
incident.
4259

4360
## Enforcement Guidelines
4461

45-
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
62+
Community leaders will follow these Community Impact Guidelines in determining the consequences for
63+
any action they deem in violation of this Code of Conduct:
4664

4765
### 1. Correction
4866

49-
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
67+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or
68+
unwelcome in the community.
5069

51-
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
70+
**Consequence**: A private, written warning from community leaders, providing clarity around the
71+
nature of the violation and an explanation of why the behavior was inappropriate. A public apology
72+
may be requested.
5273

5374
### 2. Warning
5475

5576
**Community Impact**: A violation through a single incident or series of actions.
5677

57-
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
78+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people
79+
involved, including unsolicited interaction with those enforcing the Code of Conduct, for a
80+
specified period of time. This includes avoiding interactions in community spaces as well as
81+
external channels like social media. Violating these terms may lead to a temporary or permanent ban.
5882

5983
### 3. Temporary Ban
6084

61-
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
85+
**Community Impact**: A serious violation of community standards, including sustained inappropriate
86+
behavior.
6287

63-
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
88+
**Consequence**: A temporary ban from any sort of interaction or public communication with the
89+
community for a specified period of time. No public or private interaction with the people involved,
90+
including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this
91+
period. Violating these terms may lead to a permanent ban.
6492

6593
### 4. Permanent Ban
6694

67-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
95+
**Community Impact**: Demonstrating a pattern of violation of community standards, including
96+
sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement
97+
of classes of individuals.
6898

6999
**Consequence**: A permanent ban from any sort of public interaction within the community.
70100

71101
## Attribution
72102

73-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
103+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at
104+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74105

75-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
106+
Community Impact Guidelines were inspired by
107+
[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76108

77109
[homepage]: https://www.contributor-covenant.org
78110

79-
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
111+
For answers to common questions about this code of conduct, see the FAQ at
112+
https://www.contributor-covenant.org/faq. Translations are available at
113+
https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

+36-8
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,15 @@
22

33
## Reporting Issues
44

5-
If you find an issue, please [report it here](https://github.com/jmcdo29/nest-commander/issues/new/choose). Follow the issue template and please fill out the information. Especially if it is a bug, please provide a [minimum reproduction repository](https://minimum-reproduction.wtf).
5+
If you find an issue, please
6+
[report it here](https://github.com/jmcdo29/nest-commander/issues/new/choose). Follow the issue
7+
template and please fill out the information. Especially if it is a bug, please provide a
8+
[minimum reproduction repository](https://minimum-reproduction.wtf).
69

710
## Pre-Requisites
811

9-
- [pnpm installed](https://pnpm.io) (you can try using `yarn` or `npm`, but sometimes they don't play nicely with the pnpm workspace)
12+
- [pnpm installed](https://pnpm.io) (you can try using `yarn` or `npm`, but sometimes they don't
13+
play nicely with the pnpm workspace)
1014
- [Basic knowledge of Nx](https://nx.dev)
1115

1216
### Getting Started
@@ -22,26 +26,50 @@ And now you should be good to go
2226

2327
### Project Structure
2428

25-
`nest-commander` uses an [`nx`](https://nx.dev) workspace for development. This means that the packages can be found under `packages/` and each package has its own set of commands that can be found in the [`workspace.json`](./workspace.json) file. All of the docs for `nest-commander` can be found at `apps/docs/docs` and are all markdown files [thanks to docusaurus](https://docusaurus.io/). All integration tests can be found at `integration/`
29+
`nest-commander` uses an [`nx`](https://nx.dev) workspace for development. This means that the
30+
packages can be found under `packages/` and each package has its own set of commands that can be
31+
found in the [`workspace.json`](./workspace.json) file. All of the docs for `nest-commander` can be
32+
found at `apps/docs/docs` and are all markdown files [thanks to docusaurus](https://docusaurus.io/).
33+
All integration tests can be found at `integration/`
2634

2735
### Making changes
2836

29-
Generally changes and improvements are appreciated, especially if they make logic less complex or they end up causing [codebeat](https://codebeat.co/) report a major (greater than .2) loss in code GPA. Other than that, follow the lint rules set up in the project, and make sure the git hooks run before [opening a Pull Request](https://github.com/jmcdo29/nest-commander/compare). Also, make sure if it's a new feature or a bug fix that a test is added to the integration tests. Lastly, please resolve any merge conflicts by [rebasing](https://git-scm.com/book/en/v2/Git-Branching-Rebasing). The easiest way to go about this is to use `git pull --rebase upstream main` where `upstream` is a remote set to `https://github.com/jmcdo29/nest-commander.git` or `[email protected]:jmcdo29/nest-commander.git` depending on if you use HTTPS or SSH with your git client.
37+
Generally changes and improvements are appreciated, especially if they make logic less complex or
38+
they end up causing [codebeat](https://codebeat.co/) report a major (greater than .2) loss in code
39+
GPA. Other than that, follow the lint rules set up in the project, and make sure the git hooks run
40+
before [opening a Pull Request](https://github.com/jmcdo29/nest-commander/compare). Also, make sure
41+
if it's a new feature or a bug fix that a test is added to the integration tests. Lastly, please
42+
resolve any merge conflicts by [rebasing](https://git-scm.com/book/en/v2/Git-Branching-Rebasing).
43+
The easiest way to go about this is to use `git pull --rebase upstream main` where `upstream` is a
44+
remote set to `https://github.com/jmcdo29/nest-commander.git` or
45+
`[email protected]:jmcdo29/nest-commander.git` depending on if you use HTTPS or SSH with your git
46+
client.
3047

3148
#### Adding a Changeset
3249

33-
If you're making a change that you'd like to be published, please consider running `pnpm changeset` and following the wizard for setting up a changeset for the change. When this gets merged into `main`, the GitHub Actions will end up opening a new PR afterwards for updating the version and publishing to npm. [If you're interested in how, there's a blog post about it here](https://dev.to/jmcdo29/automating-your-package-deployment-in-an-nx-monorepo-with-changeset-4em8). The wizard is pretty straight forward, I do ask that you try to follow [semver](https://semver.org/) as much as possible and don't make major changes unless absolutely necessary.
50+
If you're making a change that you'd like to be published, please consider running `pnpm changeset`
51+
and following the wizard for setting up a changeset for the change. When this gets merged into
52+
`main`, the GitHub Actions will end up opening a new PR afterwards for updating the version and
53+
publishing to npm.
54+
[If you're interested in how, there's a blog post about it here](https://dev.to/jmcdo29/automating-your-package-deployment-in-an-nx-monorepo-with-changeset-4em8).
55+
The wizard is pretty straight forward, I do ask that you try to follow [semver](https://semver.org/)
56+
as much as possible and don't make major changes unless absolutely necessary.
3457

3558
### Building just one project
3659

37-
If you need to just build a single project, you can use `pnpm nx build <project-name>`. If you want to build everything that has been affected you can instead use `pnpm build` which will use `nx affected:build` instead.
60+
If you need to just build a single project, you can use `pnpm nx build <project-name>`. If you want
61+
to build everything that has been affected you can instead use `pnpm build` which will use
62+
`nx affected:build` instead.
3863

3964
### Testing just one suite
4065

41-
To run the tests, you can use `pnpm e2e` or `pnpm nx e2e integration`, this will run all of the integration tests, it shouldn't take more than 15 seconds. If it does, there's most likely an `exit` call that was mocked and not restored. Ping me on discord and we can try to find it.
66+
To run the tests, you can use `pnpm e2e` or `pnpm nx e2e integration`, this will run all of the
67+
integration tests, it shouldn't take more than 15 seconds. If it does, there's most likely an `exit`
68+
call that was mocked and not restored. Ping me on discord and we can try to find it.
4269

4370
If you need to just run one of the test suites you can use `pnpm e2e -- --testFile=<fileName>`.
4471

4572
## Keeping in touch
4673

47-
You can get a hold of me (Jay) by [emailing me](mailto:[email protected]) or by contacting me on [the Nest Discord](https://discord.gg/6byqVsXzaF) (there's a channel dedicated to `nest-commander`)
74+
You can get a hold of me (Jay) by [emailing me](mailto:[email protected]) or by contacting me on
75+
[the Nest Discord](https://discord.gg/6byqVsXzaF) (there's a channel dedicated to `nest-commander`)

0 commit comments

Comments
 (0)