Skip to content

Commit

Permalink
Add DCO to contributing. Add deleteme markers to PR template.
Browse files Browse the repository at this point in the history
Signed-off-by: Daniel Neilson <[email protected]>
  • Loading branch information
ddneilson committed Sep 13, 2024
1 parent 2e21186 commit ea705ea
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 3 deletions.
12 changes: 12 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
*delete text starting here*
Please ensure that you have read through the [contributing guidelines](https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/CONTRIBUTING.md#contributing-via-pull-requests) before continuing.
*delete text ending here*

Fixes: *<insert link to GitHub issue here>*

### What was the problem/requirement? (What/Why)
Expand All @@ -8,28 +12,35 @@ Fixes: *<insert link to GitHub issue here>*

### How was this change tested?

*delete text starting here*
See [DEVELOPMENT.md](https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/DEVELOPMENT.md) for information on running tests.

- Have you run the unit tests?
*delete text ending here*

### Did you run the "Job Bundle Output Tests"? If not, why not? If so, paste the test results here.

*delete text starting here*
See the "Integration Tests" subsection of the
[Running Submitter Tests](https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/DEVELOPMENT.md#running-submitter-tests)
section of DEVELOPMENT.md for information on these tests.

```
Required: paste the contents of job_bundle_output_tests/test-job-bundle-results.txt here
```
*delete text ending here*

### Was this change documented?

*delete text starting here*
- Did you update all relevant docstrings for Python functions that you modified?
- Should the README.md, DEVELOPMENT.md, or other documents in the repository's docs/ directory be updated along with your change?
- Should the schema files for the adaptor's init-data or run-data be updated?
*delete text ending here*

### Is this a breaking change?

*delete text starting here*
A breaking change is one that modifies a public contract in some way or otherwise changes functionality of this application in a way
that is not backwards compatible. Examples of changes that are breaking include:

Expand All @@ -41,6 +52,7 @@ that is not backwards compatible. Examples of changes that are breaking include:
If so, then please describe the changes that users of this package must make to update their scripts, or Python applications. Also,
please ensure that the title of your commit follows our conventional commit guidelines in
[CONTRIBUTING.md](https://github.com/aws-deadline/deadline-cloud-for-maya/blob/mainline/CONTRIBUTING.md#conventional-commits) for breaking changes.
*delete text ending here*

----

Expand Down
11 changes: 8 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,15 @@ To send us a pull request, please:
If you also reformat all the code, it will be hard for us to focus on your change.
Please see [DEVELOPMENT.md](./DEVELOPMENT.md) for tips.
3. Ensure tests pass. Please see the [Testing](./DEVELOPMENT.md#testing) section for information on tests.
4. Commit to your fork using clear commit messages. Note that all AWS Deadline Cloud GitHub repositories require the use
4. **IMPORTANT**: Commit to your fork using clear commit messages. Note that all AWS Deadline Cloud GitHub repositories require the use
of [conventional commit](#conventional-commits) syntax for the title of your commit.
5. Send us a pull request, answering any default questions in the pull request interface.
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
5. **IMPORTANT**: Ensure that your commit is signed for [Developer Certificate of Origin](https://github.com/apps/dco) (`git commit --amend -s`).
Be aware that your configured `user.email` value will be embedded in the commit message for all to see. We recommend that
you configure GitHub to [block pushes that expose your email](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/blocking-command-line-pushes-that-expose-your-personal-email-address),
[setup GitHub to keep your email private](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-on-github),
and use GitHub's provided noreply email address [as the `user.email` setting in git](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address#setting-your-commit-email-address-in-git).
6. Send us a pull request, answering any default questions in the pull request interface.
7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.

GitHub provides additional documentation on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
Expand Down

0 comments on commit ea705ea

Please sign in to comment.