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: ko/resources/contributing.md
+27-27Lines changed: 27 additions & 27 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -237,18 +237,18 @@ a future release of Express.
237
237
### Steps for contributing
238
238
239
239
1. Create an issue for the
240
-
bug you want to fix or the feature that you want to add.
240
+
bug you want to fix or the feature that you want to add.
241
241
2. Create your own fork on GitHub, then
242
-
checkout your fork.
242
+
checkout your fork.
243
243
3. Write your code in your local copy. It's good practice to create a branch for
244
-
each new issue you work on, although not compulsory.
244
+
each new issue you work on, although not compulsory.
245
245
4. To run the test suite, first install the dependencies by running `npm install`,
246
-
then run `npm test`.
246
+
then run `npm test`.
247
247
5. Ensure your code is linted by running `npm run lint` -- fix any issue you
248
-
see listed.
248
+
see listed.
249
249
6. If the tests pass, you can commit your changes to your fork and then create
250
-
a pull request from there. Make sure to reference your issue from the pull
251
-
request comments by including the issue number e.g. `#123`.
250
+
a pull request from there. Make sure to reference your issue from the pull
251
+
request comments by including the issue number e.g. `#123`.
252
252
253
253
### Issues which are questions
254
254
@@ -346,22 +346,22 @@ This is the contribution documentation for the [expressjs.com](https://github.co
346
346
#### Need some ideas? These are some typical issues.
347
347
348
348
1.**Website issues**: If you see anything on the site that could use a tune-up, think about how to fix it.
349
-
- Display or screen sizing problems
350
-
- Mobile responsiveness issues
351
-
- Missing or broken accessibility features
352
-
- Website outages
353
-
- Broken links
354
-
- Page structure or user interface enhancements
349
+
- Display or screen sizing problems
350
+
- Mobile responsiveness issues
351
+
- Missing or broken accessibility features
352
+
- Website outages
353
+
- Broken links
354
+
- Page structure or user interface enhancements
355
355
356
356
2.**Content Issues**: Fix anything related to site content or typos.
357
-
- Spelling errors
358
-
- Incorrect/outdated Express JS documentation
359
-
- Missing content
357
+
- Spelling errors
358
+
- Incorrect/outdated Express JS documentation
359
+
- Missing content
360
360
361
361
3.**Translation Issues**: Fix any translation errors or contribute new content.
362
-
- Fix spelling errors
363
-
- Fix incorrect/poorly translated words
364
-
- Check out the [Contributing translations](#contributing-translations) section below for a contributing guide.
362
+
- Fix spelling errors
363
+
- Fix incorrect/poorly translated words
364
+
- Check out the [Contributing translations](#contributing-translations) section below for a contributing guide.
365
365
366
366
#### Want to work on a backlog issue?
367
367
@@ -384,12 +384,12 @@ The steps below will guide you through the Expressjs.com contribution process.
384
384
So you've found a problem that you want to fix, or have a site enhancement you want to make.
385
385
386
386
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.
387
-
- 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.
388
-
- For submissions proposing minor improvements or corrections, this is not needed. You can skip this step.
389
-
- 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.
387
+
- 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.
388
+
- For submissions proposing minor improvements or corrections, this is not needed. You can skip this step.
389
+
- 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.
390
390
391
391
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.
392
-
- For submissions proposing significant change, we encourage you to follow the review process before starting work.
392
+
- For submissions proposing significant change, we encourage you to follow the review process before starting work.
393
393
394
394
#### Step 2: Get the Application Code Base
395
395
@@ -434,12 +434,12 @@ The Express JS website is built using [Jekyll](https://jekyllrb.com/) and is hos
434
434
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.
435
435
436
436
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.
437
-
- This is the recommended option for moderate to complex work.
437
+
- This is the recommended option for moderate to complex work.
438
438
439
439
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/).
440
-
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.
441
-
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.
442
-
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.
440
+
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.
441
+
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.
442
+
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.
0 commit comments