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.DOCS.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,10 @@
3
3
The sequelize documentation is divided in two parts:
4
4
5
5
- Tutorials, guides, and example based documentation are written in Markdown
6
-
- The API reference is generated automatically from source code comments with [ESDoc](http://esdoc.org) (which uses [JSDoc](http://usejsdoc.org) syntax).
6
+
- The API reference is generated automatically from source code comments and types with [TypeDoc](https://typedoc.org/).
7
7
8
-
The whole documentation is rendered using ESDoc and continuously deployed to Github Pages at https://sequelize.org. The output is produced in the `esdoc` folder.
8
+
The tutorials, written in markdown, are located at the [website repository](https://github.com/sequelize/website).
9
9
10
-
The tutorials, written in markdown, are located in the `docs`folder. ESDoc is configured to find them in the `"manual"` field of `.esdoc.json`.
10
+
To generate the API reference locally, run `yarn docs`and open the generated `.typedoc-build/index.html` in your favorite browser.
11
11
12
-
To generate the documentations locally, run `yarn docs`and open the generated `esdoc/index.html` in your favorite browser.
12
+
The whole documentation is rendered using [Docusaurus](https://docusaurus.io/)and continuously deployed to https://sequelize.org. See the [website repository](https://github.com/sequelize/website) for more information.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -25,7 +25,7 @@ Learn to use [GitHub flavored markdown](https://help.github.com/articles/github-
25
25
26
26
### Opening an issue to report a bug
27
27
28
-
It is essential that you provide an [SSCCE](http://sscce.org/)/[MCVE](https://stackoverflow.com/help/minimal-reproducible-example) for your issue. You can use the [papb/sequelize-sscce](https://github.com/papb/sequelize-sscce) repository. Tell us what is the actual (incorrect) behavior and what should have happened (do not expect the maintainers to know what should happen!). Make sure you checked the bug persists in the latest Sequelize version.
28
+
It is essential that you provide an [SSCCE](http://sscce.org/)/[MCVE](https://stackoverflow.com/help/minimal-reproducible-example) for your issue. You can use the [sequelize-sscce](https://github.com/sequelize/sequelize-sscce) repository. Tell us what is the actual (incorrect) behavior and what should have happened (do not expect the maintainers to know what should happen!). Make sure you checked the bug persists in the latest Sequelize version.
29
29
30
30
If you can even provide a Pull Request with a failing test (unit test or integration test), that is great! The bug will likely be fixed much faster in this case.
31
31
@@ -67,7 +67,7 @@ A Pull Request is a request for maintainers to "pull" a specific change in code
67
67
68
68
Anyone can open a Pull Request, there is no need to ask for permission. Maintainers will look at your pull request and tell you if anything else must be done before it can be merged.
69
69
70
-
The target of the Pull Request should be the `main` branch (or in rare cases the `v5` branch, if previously agreed with a maintainer).
70
+
The target of the Pull Request should be the `main` branch (or in rare cases the `v6` branch, if previously agreed with a maintainer).
71
71
72
72
Please check the _allow edits from maintainers_ box when opening it. Thank you in advance for any pull requests that you open!
73
73
@@ -120,7 +120,7 @@ Once installed, run the `yarn build` command to build the project.
120
120
121
121
#### 2.1 Adding and updating dependencies
122
122
123
-
[Yarn v3](https://yarnpkg.com//) is used in the CI/CD pipeline so adding and updating dependencies must be done with Yarn.
123
+
[Yarn v4](https://yarnpkg.com//) is used in the CI/CD pipeline so adding and updating dependencies must be done with Yarn.
124
124
125
125
#### 2.2 Running commands
126
126
@@ -158,11 +158,11 @@ If you're happy to run tests only against an SQLite database, you can skip this
158
158
159
159
If you have Docker installed, use any of the following commands to start fresh local databases of the dialect of your choice:
_Note:_ if you're using Windows, make sure you run these from Git Bash (or another MinGW environment), since these commands will execute bash scripts. Recall that [it's very easy to include Git Bash as your default integrated terminal on Visual Studio Code](https://code.visualstudio.com/docs/editor/integrated-terminal).
0 commit comments