11# Contributing Guide
22
3- This document aims to describe the workflows and rules used for developing this
4- project. This includes, but is not limited to:
3+ This document aims to describe the workflows and rules used for developing this project.
4+
5+ This includes, but is not limited to:
56
67- how to contribute code (coding standards, testing, documenting source code)
78- how pull requests are handled
@@ -47,12 +48,10 @@ Follow the steps below to setup your local development environment:
4748 yarn
4849 ```
4950
50- ** Note** : This project uses [ Yarn 2] [ 3 ] . Consult [ ` .yarnrc.yml ` ] ( .yarnrc.yml )
51- for an overview of configuration options and required environment variables.
52- Furthermore, if you already have a global Yarn configuration, or any ` YARN_* `
53- environment variables set, an error will be thrown if any settings conflict
54- with the project's Yarn configuration, or the Yarn 2 API. Missing environment
55- variables will also yield an error.
51+ ** Note** : This project uses [ Yarn 2] [ 3 ] . Consult [ ` .yarnrc.yml ` ] ( .yarnrc.yml ) for an overview of configuration
52+ options and required environment variables. Furthermore, if you already have a global Yarn configuration, or any
53+ ` YARN_* ` environment variables set, an error will be thrown if any settings conflict with the project's Yarn
54+ configuration, or the Yarn 2 API. Missing environment variables will also yield an error.
5655
57567 . [ ZSH] [ 4 ] setup
5857
@@ -115,11 +114,9 @@ See [`.github/.gitconfig`](.github/.gitconfig) for an exhaustive list.
115114
116115## Contributing Code
117116
118- [ Husky] [ 5 ] is used to locally enforce coding and commit message standards, as
119- well as run tests pre-push.
117+ [ Husky] [ 5 ] is used to locally enforce coding and commit message standards, as well as run tests pre-push.
120118
121- Any code merged into the [ trunk] ( #branching-model ) must confront the following
122- criteria:
119+ Any code merged into the [ trunk] ( #branching-model ) must confront the following criteria:
123120
124121- changes should be discussed prior to implementation
125122- changes have been tested properly
@@ -128,8 +125,7 @@ criteria:
128125
129126### Branching Model
130127
131- This project follows a [ Trunk Based Development] [ 6 ] workflow, specifically the
132- [ short-lived branch style] [ 7 ] .
128+ This project follows a [ Trunk Based Development] [ 6 ] workflow, specifically the [ short-lived branch style] [ 7 ] .
133129
134130- Trunk Branch: ` main `
135131- Short-Lived Branches: ` feat/* ` , ` hotfix/* ` , ` release/* `
@@ -152,8 +148,7 @@ When creating a new branch, the name should match the following format:
152148
153149### Commit Messages
154150
155- This project follows [ Conventional Commit] [ 8 ] standards and uses [ commitlint] [ 9 ]
156- to enforce those standards.
151+ This project follows [ Conventional Commit] [ 8 ] standards and uses [ commitlint] [ 9 ] to enforce those standards.
157152
158153This means every commit must conform to the following format:
159154
@@ -221,8 +216,7 @@ Source code is located in [`src`](src) directory.
221216
222217- JavaScript & TypeScript: [ JSDoc] [ 12 ] ; linted with [ ` eslint-plugin-jsdoc ` ] [ 13 ]
223218
224- Before making a pull request, be sure your code is well documented, as it will
225- be part of your code review.
219+ Before making a pull request, be sure your code is well documented, as it will be part of your code review.
226220
227221### Testing
228222
@@ -240,15 +234,14 @@ Be sure to use [`it.skip`][15] or [`it.todo`][16] where appropriate.
240234
241235### Getting Help
242236
243- If you need help, make note of any issues in their respective files in the form
244- of a [ JSDoc comment] [ 12 ] . If you need help with a test, don't forget to use
245- [ ` it.skip ` ] [ 15 ] and/or [ ` it.todo ` ] [ 16 ] . Afterwards, [ start a discussion in the
237+ If you need help, make note of any issues in their respective files in the form of a [ JSDoc comment] [ 12 ] . If you need
238+ help with a test, don't forget to use [ ` it.skip ` ] [ 15 ] and/or [ ` it.todo ` ] [ 16 ] . Afterwards, [ start a discussion in the
246239Q&A category] [ 17 ] .
247240
248241## Labels
249242
250- This project uses a well-defined list of labels to organize issues and pull
251- requests. Most labels are scoped (i.e: ` status: ` ).
243+ This project uses a well-defined list of labels to organize issues and pull requests. Most labels are scoped (i.e:
244+ ` status: ` ).
252245
253246A list of labels can be found in [ ` .github/labels.yml ` ] ( .github/labels.yml ) .
254247
@@ -260,8 +253,7 @@ Before opening an issue, make sure you have:
260253- checked that the issue hasn't already been filed by searching open issues
261254- searched closed issues for solution(s) or feedback
262255
263- If you haven't found a related open issue, or feel that a closed issue should be
264- re-visited, open a new issue.
256+ If you haven't found a related open issue, or feel that a closed issue should be re-visited, open a new issue.
265257
266258A well-written issue
267259
@@ -272,8 +264,7 @@ A well-written issue
272264
273265## Pull Requests
274266
275- When you're ready to submit your changes, open a pull request (PR) against
276- ` main ` :
267+ When you're ready to submit your changes, open a pull request (PR) against ` main ` :
277268
278269``` sh
279270https://github.com/flex-development/aggregate-error-ponyfill/compare/main...$branch
@@ -296,13 +287,12 @@ Every PR you open should:
296287
297288### Pull Request Titles
298289
299- To keep in line with [ commit message standards] ( #commit-messages ) after PRs are
300- merged, PR titles are expected to adhere to the same rules.
290+ To keep in line with [ commit message standards] ( #commit-messages ) after PRs are merged, PR titles are expected to adhere
291+ to the same rules.
301292
302293## Merge Strategies
303294
304- In every repository, the ` rebase and merge ` and ` squash and merge ` options are
305- enabled.
295+ In every repository, the ` rebase and merge ` and ` squash and merge ` options are enabled.
306296
307297- ** rebase and merge** : PR has one commit or commits that are not grouped
308298- ** squash and merge** : PR has one commit or a group of commits
333323# # Deployment
334324
335325> Note: Package and release publication is executed via GitHub workflow.\
336- > This is so invalid or malicious versions cannot be published without merging those
337- > changes into ` main` first.
326+ > This is so invalid or malicious versions cannot be published without merging those changes into ` main` first.
338327
339328Before deploying, the following steps must be completed:
340329
@@ -366,8 +355,7 @@ Before deploying, the following steps must be completed:
366355 - create and publish github release
367356 - make sure all prereleased or released issues are closed
368357 - delete the release branch
369- - on release publish, [publish workflow](.github/workflows/publish.yml)
370- will fire
358+ - on release publish, [publish workflow](.github/workflows/publish.yml) will fire
371359 - if successful, the workflow will:
372360 - publish package to [github package registry][19]
373361 - publish package to [npm][20]
0 commit comments