|
|
|
|
@@ -33,7 +33,7 @@ The goal of this document is to create a contribution process that:
|
|
|
|
|
- Encourages contributors to remain involved.
|
|
|
|
|
- Avoids unnecessary processes and bureaucracy whenever possible.
|
|
|
|
|
- Creates a transparent decision making process that makes it clear how
|
|
|
|
|
contributors can be involved in decision making.
|
|
|
|
|
contributors can be involved in decision making.
|
|
|
|
|
|
|
|
|
|
### Vocabulary
|
|
|
|
|
|
|
|
|
|
@@ -41,7 +41,7 @@ The goal of this document is to create a contribution process that:
|
|
|
|
|
- A **Committer** is a subset of contributors who have been given write access to the repository.
|
|
|
|
|
- A **Project Captain** is the lead maintainer of a repository.
|
|
|
|
|
- A **TC (Technical Committee)** is a group of committers representing the required technical
|
|
|
|
|
expertise to resolve rare disputes.
|
|
|
|
|
expertise to resolve rare disputes.
|
|
|
|
|
- A **Triager** is a subset of contributors who have been given triage access to the repository.
|
|
|
|
|
|
|
|
|
|
### Logging Issues
|
|
|
|
|
@@ -88,7 +88,7 @@ compromise among committers be the default resolution mechanism.
|
|
|
|
|
### Becoming a Triager
|
|
|
|
|
|
|
|
|
|
Anyone can become a triager! Read more about the process of being a triager in
|
|
|
|
|
[the triage process document](https://github.com/expressjs/express/blob/master/Triager-Guide.md).
|
|
|
|
|
[the triage process document](https://github.com/expressjs/discussions/blob/master/Triager-Guide.md).
|
|
|
|
|
|
|
|
|
|
Currently, any existing [organization member](https://github.com/orgs/expressjs/people) can nominate
|
|
|
|
|
a new triager. If you are interested in becoming a triager, our best advice is to actively participate
|
|
|
|
|
@@ -169,7 +169,7 @@ name, the nominee's GitHub handle, and their npm username (if different).
|
|
|
|
|
|
|
|
|
|
- Repos can have as many captains as make sense for the scope of work.
|
|
|
|
|
- A TC member or an existing repo captain **on the same project** can nominate a new captain.
|
|
|
|
|
Repo captains from other projects should not nominate captains for a different project.
|
|
|
|
|
Repo captains from other projects should not nominate captains for a different project.
|
|
|
|
|
|
|
|
|
|
The PR will require at least 2 approvals from TC members and 2 weeks hold time to allow
|
|
|
|
|
for comment and/or dissent. When the PR is merged, a TC member will add them to the
|
|
|
|
|
@@ -177,72 +177,11 @@ proper GitHub/npm groups.
|
|
|
|
|
|
|
|
|
|
#### Active Projects and Captains
|
|
|
|
|
|
|
|
|
|
- [`expressjs/badgeboard`](https://github.com/expressjs/badgeboard): @wesleytodd
|
|
|
|
|
- [`expressjs/basic-auth-connect`](https://github.com/expressjs/basic-auth-connect): @ulisesGascon
|
|
|
|
|
- [`expressjs/body-parser`](https://github.com/expressjs/body-parser): @wesleytodd, @jonchurch, @ulisesGascon
|
|
|
|
|
- [`expressjs/compression`](https://github.com/expressjs/compression): @ulisesGascon
|
|
|
|
|
- [`expressjs/connect-multiparty`](https://github.com/expressjs/connect-multiparty): @ulisesGascon
|
|
|
|
|
- [`expressjs/cookie-parser`](https://github.com/expressjs/cookie-parser): @wesleytodd, @UlisesGascon
|
|
|
|
|
- [`expressjs/cookie-session`](https://github.com/expressjs/cookie-session): @ulisesGascon
|
|
|
|
|
- [`expressjs/cors`](https://github.com/expressjs/cors): @jonchurch, @ulisesGascon
|
|
|
|
|
- [`expressjs/discussions`](https://github.com/expressjs/discussions): @wesleytodd
|
|
|
|
|
- [`expressjs/errorhandler`](https://github.com/expressjs/errorhandler): @ulisesGascon
|
|
|
|
|
- [`expressjs/express-paginate`](https://github.com/expressjs/express-paginate): @ulisesGascon
|
|
|
|
|
- [`expressjs/express`](https://github.com/expressjs/express): @wesleytodd, @ulisesGascon
|
|
|
|
|
- [`expressjs/expressjs.com`](https://github.com/expressjs/expressjs.com): @crandmck, @jonchurch, @bjohansebas
|
|
|
|
|
- [`expressjs/flash`](https://github.com/expressjs/flash): @ulisesGascon
|
|
|
|
|
- [`expressjs/generator`](https://github.com/expressjs/generator): @wesleytodd
|
|
|
|
|
- [`expressjs/method-override`](https://github.com/expressjs/method-override): @ulisesGascon
|
|
|
|
|
- [`expressjs/morgan`](https://github.com/expressjs/morgan): @jonchurch, @ulisesGascon
|
|
|
|
|
- [`expressjs/multer`](https://github.com/expressjs/multer): @LinusU, @ulisesGascon
|
|
|
|
|
- [`expressjs/response-time`](https://github.com/expressjs/response-time): @UlisesGascon
|
|
|
|
|
- [`expressjs/serve-favicon`](https://github.com/expressjs/serve-favicon): @ulisesGascon
|
|
|
|
|
- [`expressjs/serve-index`](https://github.com/expressjs/serve-index): @ulisesGascon
|
|
|
|
|
- [`expressjs/serve-static`](https://github.com/expressjs/serve-static): @ulisesGascon
|
|
|
|
|
- [`expressjs/session`](https://github.com/expressjs/session): @ulisesGascon
|
|
|
|
|
- [`expressjs/statusboard`](https://github.com/expressjs/statusboard): @wesleytodd
|
|
|
|
|
- [`expressjs/timeout`](https://github.com/expressjs/timeout): @ulisesGascon
|
|
|
|
|
- [`expressjs/vhost`](https://github.com/expressjs/vhost): @ulisesGascon
|
|
|
|
|
- [`jshttp/accepts`](https://github.com/jshttp/accepts): @blakeembrey
|
|
|
|
|
- [`jshttp/basic-auth`](https://github.com/jshttp/basic-auth): @blakeembrey
|
|
|
|
|
- [`jshttp/compressible`](https://github.com/jshttp/compressible): @blakeembrey
|
|
|
|
|
- [`jshttp/content-disposition`](https://github.com/jshttp/content-disposition): @blakeembrey
|
|
|
|
|
- [`jshttp/content-type`](https://github.com/jshttp/content-type): @blakeembrey
|
|
|
|
|
- [`jshttp/cookie`](https://github.com/jshttp/cookie): @blakeembrey
|
|
|
|
|
- [`jshttp/etag`](https://github.com/jshttp/etag): @blakeembrey
|
|
|
|
|
- [`jshttp/forwarded`](https://github.com/jshttp/forwarded): @blakeembrey
|
|
|
|
|
- [`jshttp/fresh`](https://github.com/jshttp/fresh): @blakeembrey
|
|
|
|
|
- [`jshttp/http-assert`](https://github.com/jshttp/http-assert): @wesleytodd, @jonchurch, @ulisesGascon
|
|
|
|
|
- [`jshttp/http-errors`](https://github.com/jshttp/http-errors): @wesleytodd, @jonchurch, @ulisesGascon
|
|
|
|
|
- [`jshttp/media-typer`](https://github.com/jshttp/media-typer): @blakeembrey
|
|
|
|
|
- [`jshttp/methods`](https://github.com/jshttp/methods): @blakeembrey
|
|
|
|
|
- [`jshttp/mime-db`](https://github.com/jshttp/mime-db): @blakeembrey, @UlisesGascon
|
|
|
|
|
- [`jshttp/mime-types`](https://github.com/jshttp/mime-types): @blakeembrey, @UlisesGascon
|
|
|
|
|
- [`jshttp/negotiator`](https://github.com/jshttp/negotiator): @blakeembrey
|
|
|
|
|
- [`jshttp/on-finished`](https://github.com/jshttp/on-finished): @wesleytodd, @ulisesGascon
|
|
|
|
|
- [`jshttp/on-headers`](https://github.com/jshttp/on-headers): @blakeembrey
|
|
|
|
|
- [`jshttp/proxy-addr`](https://github.com/jshttp/proxy-addr): @wesleytodd, @ulisesGascon
|
|
|
|
|
- [`jshttp/range-parser`](https://github.com/jshttp/range-parser): @blakeembrey
|
|
|
|
|
- [`jshttp/statuses`](https://github.com/jshttp/statuses): @blakeembrey
|
|
|
|
|
- [`jshttp/type-is`](https://github.com/jshttp/type-is): @blakeembrey
|
|
|
|
|
- [`jshttp/vary`](https://github.com/jshttp/vary): @blakeembrey
|
|
|
|
|
- [`pillarjs/cookies`](https://github.com/pillarjs/cookies): @blakeembrey
|
|
|
|
|
- [`pillarjs/csrf`](https://github.com/pillarjs/csrf): @ulisesGascon
|
|
|
|
|
- [`pillarjs/encodeurl`](https://github.com/pillarjs/encodeurl): @blakeembrey
|
|
|
|
|
- [`pillarjs/finalhandler`](https://github.com/pillarjs/finalhandler): @wesleytodd, @ulisesGascon
|
|
|
|
|
- [`pillarjs/hbs`](https://github.com/pillarjs/hbs): @ulisesGascon
|
|
|
|
|
- [`pillarjs/multiparty`](https://github.com/pillarjs/multiparty): @blakeembrey
|
|
|
|
|
- [`pillarjs/parseurl`](https://github.com/pillarjs/parseurl): @blakeembrey
|
|
|
|
|
- [`pillarjs/path-to-regexp`](https://github.com/pillarjs/path-to-regexp): @blakeembrey
|
|
|
|
|
- [`pillarjs/request`](https://github.com/pillarjs/request): @wesleytodd
|
|
|
|
|
- [`pillarjs/resolve-path`](https://github.com/pillarjs/resolve-path): @blakeembrey
|
|
|
|
|
- [`pillarjs/router`](https://github.com/pillarjs/router): @wesleytodd, @ulisesGascon
|
|
|
|
|
- [`pillarjs/send`](https://github.com/pillarjs/send): @blakeembrey
|
|
|
|
|
- [`pillarjs/understanding-csrf`](https://github.com/pillarjs/understanding-csrf): @ulisesGascon
|
|
|
|
|
The list can be found at [https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#active-projects-and-members](https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#active-projects-and-members)
|
|
|
|
|
|
|
|
|
|
#### Current Initiative Captains
|
|
|
|
|
|
|
|
|
|
- Triage team [ref](https://github.com/expressjs/discussions/issues/227): @UlisesGascon
|
|
|
|
|
The list can be found at [https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#current-initiative-captains](https://github.com/expressjs/discussions/blob/HEAD/docs/contributing/captains_and_committers.md#current-initiative-captains)
|
|
|
|
|
|
|
|
|
|
### Developer's Certificate of Origin 1.1
|
|
|
|
|
|
|
|
|
|
@@ -280,6 +219,8 @@ By making a contribution to this project, I certify that:
|
|
|
|
|
|
|
|
|
|
Open issues for the expressjs.com website in https://github.com/expressjs/expressjs.com.
|
|
|
|
|
|
|
|
|
|
For issues in other Express managed repos (everything in `expressjs`, `pillarjs` or `jshttp` other than `expressjs/express`), be sure to check their contributing guide and open issues and PRs in the appropriate repository.
|
|
|
|
|
|
|
|
|
|
### PRs and Code contributions
|
|
|
|
|
|
|
|
|
|
- Tests must pass.
|
|
|
|
|
@@ -291,24 +232,24 @@ Open issues for the expressjs.com website in https://github.com/expressjs/expres
|
|
|
|
|
Use the `master` branch for bug fixes or minor work that is intended for the
|
|
|
|
|
current release stream.
|
|
|
|
|
|
|
|
|
|
Use the correspondingly named branch, e.g. `5.0`, for anything intended for
|
|
|
|
|
Use the correspondingly named branch, e.g. `6.x`, for anything intended for
|
|
|
|
|
a future release of Express.
|
|
|
|
|
|
|
|
|
|
### Steps for contributing
|
|
|
|
|
|
|
|
|
|
1. [Create an issue](https://github.com/expressjs/express/issues/new) for the
|
|
|
|
|
bug you want to fix or the feature that you want to add.
|
|
|
|
|
2. Create your own [fork](https://github.com/expressjs/express) on GitHub, then
|
|
|
|
|
checkout your fork.
|
|
|
|
|
1. Create an issue for the
|
|
|
|
|
bug you want to fix or the feature that you want to add.
|
|
|
|
|
2. Create your own fork on GitHub, then
|
|
|
|
|
checkout your fork.
|
|
|
|
|
3. Write your code in your local copy. It's good practice to create a branch for
|
|
|
|
|
each new issue you work on, although not compulsory.
|
|
|
|
|
each new issue you work on, although not compulsory.
|
|
|
|
|
4. To run the test suite, first install the dependencies by running `npm install`,
|
|
|
|
|
then run `npm test`.
|
|
|
|
|
then run `npm test`.
|
|
|
|
|
5. Ensure your code is linted by running `npm run lint` -- fix any issue you
|
|
|
|
|
see listed.
|
|
|
|
|
see listed.
|
|
|
|
|
6. If the tests pass, you can commit your changes to your fork and then create
|
|
|
|
|
a pull request from there. Make sure to reference your issue from the pull
|
|
|
|
|
request comments by including the issue number e.g. `#123`.
|
|
|
|
|
a pull request from there. Make sure to reference your issue from the pull
|
|
|
|
|
request comments by including the issue number e.g. `#123`.
|
|
|
|
|
|
|
|
|
|
### Issues which are questions
|
|
|
|
|
|
|
|
|
|
@@ -326,9 +267,17 @@ Things that will help get your question issue looked at:
|
|
|
|
|
If you post a question and do not outline the above items or make it easy for
|
|
|
|
|
us to understand and reproduce your issue, it will be closed.
|
|
|
|
|
|
|
|
|
|
If your question meets all of the above requirements but you do not believe it needs to be looked at
|
|
|
|
|
by the maintainers
|
|
|
|
|
(for example, if you are just looking for community input) please open it as a discussion topic instead
|
|
|
|
|
of an issue. If you
|
|
|
|
|
are unsure and open an issue, we may move it to discussions if we triage them and decide they do
|
|
|
|
|
not need high
|
|
|
|
|
visibility or maintainer input.
|
|
|
|
|
|
|
|
|
|
## Security Policies and Procedures
|
|
|
|
|
|
|
|
|
|
<!-- SRC: expressjs/express Security.md -->
|
|
|
|
|
<!-- SRC: expressjs/express SECURITY.md -->
|
|
|
|
|
|
|
|
|
|
This document outlines security procedures and general policies for the Express
|
|
|
|
|
project.
|
|
|
|
|
@@ -374,7 +323,7 @@ involving the following steps:
|
|
|
|
|
- Confirm the problem and determine the affected versions.
|
|
|
|
|
- Audit code to find any potential similar problems.
|
|
|
|
|
- Prepare fixes for all releases still under maintenance. These fixes will be
|
|
|
|
|
released as fast as possible to npm.
|
|
|
|
|
released as fast as possible to npm.
|
|
|
|
|
|
|
|
|
|
### The Express Threat Model
|
|
|
|
|
|
|
|
|
|
@@ -393,35 +342,27 @@ pull request.
|
|
|
|
|
|
|
|
|
|
### The Official Documentation of the Express JS Framework
|
|
|
|
|
|
|
|
|
|
This is the contribution documentation for the [Expressjs.com](https://github.com/expressjs/expressjs.com) website.
|
|
|
|
|
This is the contribution documentation for the [expressjs.com](https://github.com/expressjs/expressjs.com) website.
|
|
|
|
|
|
|
|
|
|
#### Need some ideas? These are some typical issues.
|
|
|
|
|
|
|
|
|
|
1. **Website issues**:
|
|
|
|
|
If you see anything on the site that could use a tune-up, think about how to fix it.
|
|
|
|
|
1. **Website issues**: If you see anything on the site that could use a tune-up, think about how to fix it.
|
|
|
|
|
- Display or screen sizing problems
|
|
|
|
|
- Mobile responsiveness issues
|
|
|
|
|
- Missing or broken accessibility features
|
|
|
|
|
- Website outages
|
|
|
|
|
- Broken links
|
|
|
|
|
- Page structure or user interface enhancements
|
|
|
|
|
|
|
|
|
|
- Display or screen sizing problems
|
|
|
|
|
- Mobile responsiveness issues
|
|
|
|
|
- Missing or broken accessibility features
|
|
|
|
|
- Website outages
|
|
|
|
|
- Broken links
|
|
|
|
|
- Page structure or user interface enhancements
|
|
|
|
|
|
|
|
|
|
2. **Content Issues**:
|
|
|
|
|
Fix anything related to site content or typos.
|
|
|
|
|
- Spelling errors
|
|
|
|
|
- Incorrect/outdated Express JS documentation
|
|
|
|
|
- Missing content
|
|
|
|
|
2. **Content Issues**: Fix anything related to site content or typos.
|
|
|
|
|
- Spelling errors
|
|
|
|
|
- Incorrect/outdated Express JS documentation
|
|
|
|
|
- Missing content
|
|
|
|
|
|
|
|
|
|
3. **Translation Issues**: Fix any translation errors or contribute new content.
|
|
|
|
|
- Fix spelling errors
|
|
|
|
|
- Fix incorrect/poorly translated words
|
|
|
|
|
- Translate new content
|
|
|
|
|
|
|
|
|
|
> **IMPORTANT:**
|
|
|
|
|
> All translation submissions are currently paused. See this [notice](#notice-we-have-paused-all-translation-contributions) for more information.
|
|
|
|
|
|
|
|
|
|
- Check out the [Contributing translations](#contributing-translations) section below for a contributing guide.
|
|
|
|
|
- Fix spelling errors
|
|
|
|
|
- Fix incorrect/poorly translated words
|
|
|
|
|
- Check out the [Contributing translations](#contributing-translations) section below for a contributing guide.
|
|
|
|
|
|
|
|
|
|
#### Want to work on a backlog issue?
|
|
|
|
|
|
|
|
|
|
@@ -432,6 +373,7 @@ We often have bugs or enhancements that need work. You can find these under our
|
|
|
|
|
If you've found a bug or a typo, or if you have an idea for an enhancement, you can:
|
|
|
|
|
|
|
|
|
|
- Submit a [new issue](https://github.com/expressjs/expressjs.com/issues/new/choose) on our repo. Do this for larger proposals, or if you'd like to discuss or get feedback first.
|
|
|
|
|
|
|
|
|
|
- Make a [Github 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). If you have already done work and it's ready to go, feel free to send it our way.
|
|
|
|
|
|
|
|
|
|
## Getting Started
|
|
|
|
|
@@ -443,18 +385,18 @@ The steps below will guide you through the Expressjs.com contribution process.
|
|
|
|
|
So you've found a problem that you want to fix, or have a site enhancement you want to make.
|
|
|
|
|
|
|
|
|
|
1. If you want to get feedback or discuss, open a discussion [issue](https://github.com/expressjs/expressjs.com/issues/new/choose) prior to starting work. This is not required, but encouraged for larger proposals.
|
|
|
|
|
- While we highly encourage this step, it is only for submissions proposing significant change. It helps us to clarify and focus the work, and ensure it aligns with overall project priorities.
|
|
|
|
|
- For submissions proposing minor improvements or corrections, this is not needed. You can skip this step.
|
|
|
|
|
- When opening an issue please give it a title and fill in the description section. The more details you provide, the more feedback we can give.
|
|
|
|
|
- While we highly encourage this step, it is only for submissions proposing significant change. It helps us to clarify and focus the work, and ensure it aligns with overall project priorities.
|
|
|
|
|
- For submissions proposing minor improvements or corrections, this is not needed. You can skip this step.
|
|
|
|
|
- When opening an issue please give it a title and fill in the description section. The more details you provide, the more feedback we can give.
|
|
|
|
|
|
|
|
|
|
2. After receiving your issue the Express JS documentation team will respond with feedback. We read every submission and always try to respond quickly with feedback.
|
|
|
|
|
- For submissions proposing significant change, we encourage you to follow the review process before starting work.
|
|
|
|
|
- For submissions proposing significant change, we encourage you to follow the review process before starting work.
|
|
|
|
|
|
|
|
|
|
#### Step 2: Get the Application Code Base
|
|
|
|
|
|
|
|
|
|
Clone the repo and get the code:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
```sh
|
|
|
|
|
git clone https://github.com/expressjs/expressjs.com.git
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
@@ -471,81 +413,55 @@ But just in case you need a little extra explanation, this section below outline
|
|
|
|
|
**Includes Partials and Layout Templates**
|
|
|
|
|
|
|
|
|
|
- `_includes` are partials that are imported and reused across multiple pages.
|
|
|
|
|
- These are used to import text content for reuse across pages, such as the API documentation, e.g., `_includes > api > en > 5x`, which is included in every language.
|
|
|
|
|
- These are used to include the page components that make up site-wide user interface and periphery structure, e.g., Header, Footer, etc.
|
|
|
|
|
- These are used to import text content for reuse across pages, such as the API documentation, e.g., `_includes > api > en > 5x`, which is included in every language.
|
|
|
|
|
- These are used to include the page components that make up site-wide user interface and periphery structure, e.g., Header, Footer, etc.
|
|
|
|
|
- `_layouts` are the templates used to wrap the site's individual pages.
|
|
|
|
|
- These are used to display the structure of the site's periphery, such as the header and footer, and for injecting and displaying individual markdown pages inside the `content` tag.
|
|
|
|
|
- These are used to display the structure of the site's periphery, such as the header and footer, and for injecting and displaying individual markdown pages inside the `content` tag.
|
|
|
|
|
|
|
|
|
|
**Blog Markdown Files**
|
|
|
|
|
|
|
|
|
|
- These files make up the individual blog posts. If you want to contribute a blog post please
|
|
|
|
|
follow the specific instructions for [How to write a blog post.](https://expressjs.com/en/blog/write-post.html)
|
|
|
|
|
follow the specific instructions for [How to write a blog post.](https://expressjs.com/en/blog/write-post.html)
|
|
|
|
|
- Located under the `_posts` directory.
|
|
|
|
|
|
|
|
|
|
**CSS or Javascript**
|
|
|
|
|
|
|
|
|
|
- All css and js files are kept in `css` and `js` folders on the project root.
|
|
|
|
|
|
|
|
|
|
The Express JS website is build using [Jeykyll](https://jekyllrb.com/) and is hosted on [Github Pages](https://pages.github.com/).
|
|
|
|
|
The Express JS website is built using [Jekyll](https://jekyllrb.com/) and is hosted on [Github Pages](https://pages.github.com/).
|
|
|
|
|
|
|
|
|
|
#### Step 3: Running the Application
|
|
|
|
|
|
|
|
|
|
Now you'll need a way to see your changes, which means you'll need a running version of the application. You have two options.
|
|
|
|
|
|
|
|
|
|
1. **Run Locally**: This gets the local version of the application up and running on your machine. Follow our [Local Setup Guide](https://github.com/expressjs/expressjs.com?tab=readme-ov-file#local-setup) to use this option.
|
|
|
|
|
- This is the recommended option for moderate to complex work.
|
|
|
|
|
1. **Run Locally**: This gets the local version of the application up and running on your machine. Follow our [Local Setup Guide](https://github.com/expressjs/expressjs.com?tab=readme-ov-file#build-the-website-locally) to use this option.
|
|
|
|
|
- This is the recommended option for moderate to complex work.
|
|
|
|
|
|
|
|
|
|
2. **Run using Deploy Preview**: Use this option if you don't want to bother with a local installation. Part of our continuous integration pipeline includes [Netlify Deploy Preview](https://docs.netlify.com/site-deploys/deploy-previews/).
|
|
|
|
|
1. To use this you'll need to get your changes online - after you've made your first commit on your feature branch, make a _draft_ pull request.
|
|
|
|
|
2. After the build steps are complete, you'll have access to a **Deploy Preview** tab that will run your changes on the web, rebuilding after each commit is pushed.
|
|
|
|
|
3. After you are completely done your work and it's ready for review, remove the draft status on your pull request and submit your work.
|
|
|
|
|
1. To use this you'll need to get your changes online - after you've made your first commit on your feature branch, make a _draft_ pull request.
|
|
|
|
|
2. After the build steps are complete, you'll have access to a **Deploy Preview** tab that will run your changes on the web, rebuilding after each commit is pushed.
|
|
|
|
|
3. After you are completely done your work and it's ready for review, remove the draft status on your pull request and submit your work.
|
|
|
|
|
|
|
|
|
|
## Contributing translations
|
|
|
|
|
|
|
|
|
|
#### Notice: We have paused all translation contributions.
|
|
|
|
|
|
|
|
|
|
> **IMPORTANT:**
|
|
|
|
|
> We are currently working toward a more streamlined translations workflow. As long as this notice is posted, we will _not_ be accepting any translation submissions.
|
|
|
|
|
|
|
|
|
|
We highly encourage community translations! We no longer have professional translations, and we believe in the power of our community to provide accurate and helpful translations.
|
|
|
|
|
We use Crowdin to manage our translations in multiple languages and achieve automatic translation with artificial intelligence. Since these translations can be inefficient in some cases, we need help from the community to provide accurate and helpful translations.
|
|
|
|
|
|
|
|
|
|
The documentation is translated into these languages:
|
|
|
|
|
|
|
|
|
|
- Chinese Simplified (`zh-cn`)
|
|
|
|
|
- Chinese Traditional (`zh-tw`)
|
|
|
|
|
- English (`en`)
|
|
|
|
|
- Spanish (`es`)
|
|
|
|
|
- French (`fr`)
|
|
|
|
|
- German (`de`)
|
|
|
|
|
- Italian (`it`)
|
|
|
|
|
- Indonesian (`id`)
|
|
|
|
|
- Japanese (`ja`)
|
|
|
|
|
- Korean (`ko`)
|
|
|
|
|
- Brazilian Portuguese (`pt-br`)
|
|
|
|
|
- Russian (`ru`)
|
|
|
|
|
- Slovak (`sk`)
|
|
|
|
|
- Thai (`th`)
|
|
|
|
|
- Turkish (`tr`)
|
|
|
|
|
- Ukrainian (`uk`)
|
|
|
|
|
- Uzbek (`uz`)
|
|
|
|
|
- Simplified Chinese (`zh-cn`)
|
|
|
|
|
- Traditional Chinese (`zh-tw`)
|
|
|
|
|
- Spanish (`es`)
|
|
|
|
|
|
|
|
|
|
### Adding New Full Site Translations
|
|
|
|
|
### How to translate
|
|
|
|
|
|
|
|
|
|
If you find a translation is missing from the list you can create a new one.
|
|
|
|
|
1. Request to join the Express.js Website project on [Crowdin](https://express.crowdin.com/website)
|
|
|
|
|
2. [Select the language you want to translate](https://support.crowdin.com/joining-translation-project/#starting-translation)
|
|
|
|
|
3. [Start translating](https://support.crowdin.com/online-editor/)
|
|
|
|
|
|
|
|
|
|
To translate Expressjs.com into a new language, follow these steps:
|
|
|
|
|
|
|
|
|
|
1. Clone the [`expressjs.com`](https://github.com/expressjs/expressjs.com) repository.
|
|
|
|
|
2. Create a directory for the language of your choice using its [ISO 639-1 code](https://www.loc.gov/standards/iso639-2/php/code_list.php) as its name.
|
|
|
|
|
3. Copy `index.md`, `api.md`, `starter/`, `guide/`, `advanced/`, `resources/`, `4x/`, and `3x/`, to the language directory.
|
|
|
|
|
4. Remove the link to 2.x docs from the "API Reference" menu.
|
|
|
|
|
5. Update the `lang` variable in the copied markdown files.
|
|
|
|
|
6. Update the `title` variable in the copied markdown files.
|
|
|
|
|
7. Create the header, footer, notice, and announcement file for the language in the `_includes/` directory, in the respective directories, and make necessary edits to the contents.
|
|
|
|
|
8. Create the announcement file for the language in the `_includes/` directory.
|
|
|
|
|
9. Make sure to append `/{{ page.lang }}` to all the links within the site.
|
|
|
|
|
10. Update the [CONTRIBUTING.md](https://github.com/expressjs/expressjs.com/blob/gh-pages/CONTRIBUTING.md#contributing-translations) and the `.github/workflows/translation.yml` files with the new language.
|
|
|
|
|
|
|
|
|
|
### Adding Page and Section Translations
|
|
|
|
|
|
|
|
|
|
Many site translations are still missing pages. To find which ones we need help with, you can [filter for merged PRs](https://github.com/expressjs/expressjs.com/pulls?q=is%3Apr+is%3Aclosed+label%3Arequires-translation-es) that include the tag for your language, such as `requires-translation-es` for requires Spanish translation.
|
|
|
|
|
|
|
|
|
|
If you contribute a page or section translation, please reference the original PR. This helps the person merging your translation to remove the tag from the original PR.
|
|
|
|
|
|
github-actions[bot]