mirror of
https://github.com/freeCodeCamp/freeCodeCamp.git
synced 2026-03-26 08:01:08 -04:00
68 lines
2.5 KiB
JavaScript
68 lines
2.5 KiB
JavaScript
'use strict';
|
|
|
|
const FOOTER =
|
|
'\n\n---\nJoin us in our [chat room](https://discord.gg/PRyKn3Vbay) or our [forum](https://forum.freecodecamp.org/c/contributors/3) if you have any questions or need help with contributing.';
|
|
|
|
const TEMPLATE_BLOCK = [
|
|
'```md',
|
|
'Checklist:',
|
|
'',
|
|
'<!-- Please follow this checklist and put an x in each of the boxes, like this: [x]. It will ensure that our team takes your pull request seriously. -->',
|
|
'',
|
|
'- [ ] I have read and followed the [contribution guidelines](https://contribute.freecodecamp.org).',
|
|
'- [ ] I have read and followed the [how to open a pull request guide](https://contribute.freecodecamp.org/how-to-open-a-pull-request/).',
|
|
"- [ ] My pull request targets the `main` branch of freeCodeCamp.",
|
|
'- [ ] I have tested these changes either locally on my machine, or GitHub Codespaces.',
|
|
'',
|
|
'<!--If your pull request closes a GitHub issue, replace the XXXXX below with the issue number.-->',
|
|
'',
|
|
'Closes #XXXXX',
|
|
'',
|
|
'<!-- Feel free to add any additional description of changes below this line -->',
|
|
'```'
|
|
].join('\n');
|
|
|
|
module.exports = async ({ github, context, isAllowListed }) => {
|
|
if (isAllowListed === 'true') return;
|
|
|
|
const body = context.payload.pull_request.body || '';
|
|
|
|
// The template must be present and the first 3 checkboxes must be
|
|
// ticked ([x] or [X]). The last checkbox (tested locally) is
|
|
// acceptable to leave unticked.
|
|
const templatePresent = body.includes('Checklist:');
|
|
const requiredTicked = [
|
|
'I have read and followed the [contribution guidelines]',
|
|
'I have read and followed the [how to open a pull request guide]',
|
|
'My pull request targets the'
|
|
];
|
|
const allRequiredTicked = requiredTicked.every(
|
|
item => body.includes(`[x] ${item}`) || body.includes(`[X] ${item}`)
|
|
);
|
|
|
|
if (templatePresent && allRequiredTicked) return;
|
|
|
|
await github.rest.issues.addLabels({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: context.payload.pull_request.number,
|
|
labels: ['deprioritized']
|
|
});
|
|
|
|
await github.rest.issues.createComment({
|
|
owner: context.repo.owner,
|
|
repo: context.repo.repo,
|
|
issue_number: context.payload.pull_request.number,
|
|
body:
|
|
[
|
|
'Hi there,',
|
|
'',
|
|
'Thank you for the contribution.',
|
|
'',
|
|
"Please add back the following template to the PR description and complete the checklist items. We won't be able to review this PR until then.",
|
|
'',
|
|
TEMPLATE_BLOCK
|
|
].join('\n') + FOOTER
|
|
});
|
|
};
|