You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+15-15Lines changed: 15 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -28,7 +28,7 @@ If you intend to change the public API, or make any non-trivial changes to the i
28
28
29
29
Working on your first Pull Request? You can learn how from this free video series:
30
30
31
-
-[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
31
+
-[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
32
32
33
33
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.
34
34
@@ -55,12 +55,12 @@ cd typist
55
55
56
56
After cloning Typist and installing all dependencies, several commands are at your disposal:
57
57
58
-
-`npm run build`: Builds the `@doist/typist` package for publishing to [npm](https://www.npmjs.com/) and [GitHub Packages](https://github.com/orgs/Doist/packages?repo_name=typist);
59
-
-`npm run check`: Validates code quality with ESLint, styling with Prettier, and types with TypeScript;
60
-
-`npm run clean`: Removes temporary directories used for multiple caches;
61
-
-`npm run storybook:build`: Builds Storybook as a static Web application;
62
-
-`npm run storybook:start`: Starts Storybook Web application (available at http://localhost:6006/);
63
-
-`npm run test`: Runs all unit test with Jest and end-to-end tests with Storybook.
58
+
-`npm run build`: Builds the `@doist/typist` package for publishing to [npm](https://www.npmjs.com/) and [GitHub Packages](https://github.com/orgs/Doist/packages?repo_name=typist);
59
+
-`npm run check`: Validates code quality with ESLint, styling with Prettier, and types with TypeScript;
60
+
-`npm run clean`: Removes temporary directories used for multiple caches;
61
+
-`npm run storybook:build`: Builds Storybook as a static Web application;
62
+
-`npm run storybook:start`: Starts Storybook Web application (available at http://localhost:6006/);
63
+
-`npm run test`: Runs all unit test with Jest and end-to-end tests with Storybook.
64
64
65
65
### Release Process (core team only)
66
66
@@ -80,21 +80,21 @@ Pull requests are actively monitored, and only need the approval of one or more
80
80
81
81
Before submitting a pull request, please take the following into consideration:
82
82
83
-
-Fork [the repository](https://github.com/doist/typist) and create your branch from `main`;
84
-
-Follow the [Commit Message Guidelines](#commit-message-guidelines) below;
85
-
-Add tests for code that should be tested (like bug fixes);
86
-
-Ensure the test suite passes with flying colours;
87
-
-Do not override built-in validation and formatting checks.
83
+
- Fork [the repository](https://github.com/doist/typist) and create your branch from `main`;
84
+
- Follow the [Commit Message Guidelines](#commit-message-guidelines) below;
85
+
- Add tests for code that should be tested (like bug fixes);
86
+
- Ensure the test suite passes with flying colours;
87
+
- Do not override built-in validation and formatting checks.
88
88
89
89
### Commit Message Guidelines
90
90
91
91
#### Atomic Commits
92
92
93
93
If possible, make [atomic commits](https://en.wikipedia.org/wiki/Atomic_commit), which means:
94
94
95
-
-A commit should not mix whitespace and/or code style changes with functional code changes;
96
-
-A commit should contain exactly one self-contained functional change;
97
-
-A commit should not create an inconsistent state (e.g., test errors, linting errors, partial fix, etc.).
95
+
- A commit should not mix whitespace and/or code style changes with functional code changes;
96
+
- A commit should contain exactly one self-contained functional change;
97
+
- A commit should not create an inconsistent state (e.g., test errors, linting errors, partial fix, etc.).
0 commit comments