Update PULL_REQUEST_TEMPLATE.MD

Re-writing PULL_REQUEST_TEMPLATE.MD - moving the details into a comment, leaving only the checklist to show in the PR
This commit is contained in:
Doug Aitken 2022-10-21 22:43:47 +01:00 committed by GitHub
parent 2ae8e0576b
commit d06c87728b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,22 +1,32 @@
This Pull Request should adhere to the repository's [Code of Conduct](../../main/.github/CONTRIBUTING.md).
This is a modified version of, and should adhere to, the [Contributing Guidelines](../../main/.github/CONTRIBUTING.md).
Title your pull request descriptively. `[edit X company]` or `[add new company - COMPANY]`
<!--
Hello, thank you for your contribution, please read through this whole file before submitting your Pull Request.
Title your pull request descriptively:
* edit X company
* add new company - COMPANY
* Copy tweaks
Please read and check the boxes in the list below that apply!
If updating or adding a company, please include details here: _delete this and add details_
If updating or adding a company, please include details about what you are changing.
Check off this list as appropriate (add an `x` between the `[]`). It will be used by @dougaitken when reviewing your contribution.
If you are adding a new entry to the list, your contributio (Pull Request) should include a company profile AND line entry to the readme file.
- [] This PR contains housekeeping only (URL edits, copy changes etc) - **if this is checked, delete other lines that don't apply.**
- [] You are an employee of the company mentioned and confirm all included details are correct.
- [] You know your alphabet - company is listed in alphabetical order in the README.md file.
- [] The company directly hires employees. ** No bootcamps / freelance sites / etc**
- [] The company hires remote employees, or positions are available to remote workers and are clearly illustrated as such.
- [] A [company profile](/company-profiles/example.md) is included - This is __required__ for new additions.
- [] An entry has been added or edited within the [readme.md file](../../main/README.md).
- [] __Remote status__ has details regarding how the culture includes remote employees, how the company integrated remote workers, etc
- [] __Region__ details the geographic regions in which this company employees can reside. For more details see the instructions in the [example company profile](/company-profiles/example.md#region).
- [] __How to apply__ details the best approach for new applications, page on site where open position are listed, and any other help available for job hunters
Check off this list as appropriate (add an x between the []). It will be used by @dougaitken when reviewing your contribution, like this: [x]
This is a modified version of the [Contributing Guidelines](../../main/.github/CONTRIBUTING.md).
DO NOT DELETE ANYTHING IN THIS COMMENT.
-->
* [ ] This PR contains housekeeping only (URL edits, copy changes etc) - **if this is checked, delete other lines that don't apply**
* [ ] You are an employee of the company mentioned and confirm all included details are correct.
* [ ] You know your alphabet - company is listed in alphabetical order in the README.md file.
* [ ] The company directly hires employees. ** No bootcamps / freelance sites / etc**
* [ ] The company hires remote employees, or positions are available to remote workers and are clearly illustrated as such.
* [ ] A [company profile](/company-profiles/example.md) is included - This is __required__ for new additions.
* [ ] An entry has been added or edited within the [readme.md file](../../main/README.md).
* [ ] __Remote status__ has details regarding how the culture includes remote employees, how the company integrated remote workers, etc
* [ ] __Region__ details the geographic regions in which this company employees can reside. For more details see the instructions in the [example company profile](/company-profiles/example.md#region).
* [ ] __How to apply__ details the best approach for new applications, page on site where open position are listed, and any other help available for job hunters