Formed in 2009, the Archive Team (not to be confused with the archive.org Archive-It Team) is a rogue archivist collective dedicated to saving copies of rapidly dying or deleted websites for the sake of history and digital heritage. The group is 100% composed of volunteers and interested parties, and has expanded into a large amount of related projects for saving online and digital history.
Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign updocs: Add Submitting a Pull Request (PR) section #4364
Conversation
|
Can you enhance the existing docs in https://github.com/expressjs/express/blob/master/Collaborator-Guide.md instead of creating a duplicate location for this information? |
|
Hi @dougwilson |
|
|
||
| 1. Search [GitHub](https://github.com/expressjs/express/pulls) for an open or closed PR that relates to your submission. You don't want to duplicate effort. | ||
|
|
||
| 2. [Create an issue](https://github.com/expressjs/express/issues/new) for the |
dougwilson
Jul 27, 2020
Member
If the user is about to submit a PR, it would be best to not open an issue then open a PR. The issue this creates is that some folks may start working on the PR, but the opener was already working on it. I suggest a user either open a PR or an issue, but not both.
If the user is about to submit a PR, it would be best to not open an issue then open a PR. The issue this creates is that some folks may start working on the PR, but the opener was already working on it. I suggest a user either open a PR or an issue, but not both.
| a pull request from there. Make sure to reference your issue from the pull | ||
| request comments by including the issue number e.g. `#123`. | ||
|
|
||
| 3. Fork the `expressjs/express` repo. |
dougwilson
Jul 27, 2020
Member
What us wrong with the existing wording of the step? It seems more helpful before.
What us wrong with the existing wording of the step? It seems more helpful before.
| 7. Run the full expressjs test suite , and ensure that all tests pass : | ||
|
|
||
| ```shell | ||
| npm run test |
dougwilson
Jul 27, 2020
Member
This is just npm test
This is just npm test
| git commit -a | ||
| ``` | ||
|
|
||
| Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. |
dougwilson
Jul 27, 2020
Member
The -a does not rm any files, so I think this is misleading.
The -a does not rm any files, so I think this is misleading.
| git push origin my-fix-branch | ||
| ``` | ||
|
|
||
| 10. In GitHub, Send a pull request to `expressjs:master` |
dougwilson
Jul 27, 2020
Member
This is not always the case. I believe there is docs in here for the branches used.
This is not always the case. I believe there is docs in here for the branches used.
|
|
||
| - Make the required updates. | ||
|
|
||
| - Re-run the expressjs test suites to ensure tests are still passing. |
dougwilson
Jul 27, 2020
•
Member
expressjs is the org name, I would probably just say test suites here.
expressjs is the org name, I would probably just say test suites here.
|
|
||
| 5. Create your patch, **including appropriate test cases**. | ||
|
|
||
| 6. Install the dependencies by running : |
dougwilson
Jul 28, 2020
Member
Suggested change
6. Install the dependencies by running :
6. Install the dependencies by running:
fixed spacing
| 6. Install the dependencies by running : | |
| 6. Install the dependencies by running: |
fixed spacing
| 4. Make your changes in a new git branch: | ||
|
|
||
| ```shell | ||
| git checkout -b my-fix-branch master |
dougwilson
Jul 28, 2020
Member
Can you clarify at what indent level you are intending these blocks to be at? They start at two spaces, then a couple down just one space, and then ended with no spaces.
Can you clarify at what indent level you are intending these blocks to be at? They start at two spaces, then a couple down just one space, and then ended with no spaces.
Co-authored-by: Douglas Wilson <67512+dougwilson@users.noreply.github.com>
|
Update Collaborator-Guide |
Co-authored-by: Douglas Wilson <67512+dougwilson@users.noreply.github.com>
|
I'm going to close for now to help clean up, as it has been several months and no fixes to the noted issue or even replies to them. |
Hello,
I think , it's good idea to provide short guideline on how to submit a pull request on
expressjsrepo.This section could useful for new contributors .