gson-comments/.github/pull_request_template.md

<!--
    Thank you for your contribution!
    Please see the contributing guide: https://github.com/google/.github/blob/master/CONTRIBUTING.md

    Keep in mind that Gson is in maintenance mode. If you want to add a new feature, please first search for existing GitHub issues, or create a new one to discuss the feature and get feedback.
-->

### Purpose
<!-- Describe the purpose of this pull request, for example which new feature it adds or which bug it fixes -->
<!-- If this pull request closes a GitHub issue, please write "Closes #<issue>", for example "Closes #123" -->


### Description
<!-- If necessary provide more information, for example relevant implementation details or corner cases which are not covered yet -->
<!-- If there are related issues or pull requests, link to them by referencing their number, for example "pull request #123" -->


### Checklist
<!-- The following checklist is mainly intended for yourself to verify that you did not miss anything -->

- [ ] New code follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)\
  This is automatically checked by `mvn verify`, but can also be checked on its own using `mvn spotless:check`.\
  Style violations can be fixed using `mvn spotless:apply`; this can be done in a separate commit to verify that it did not cause undesired changes.
- [ ] If necessary, new public API validates arguments, for example rejects `null`
- [ ] New public API has Javadoc
    - [ ] Javadoc uses `@since $next-version$`  
      (`$next-version$` is a special placeholder which is automatically replaced during release)
- [ ] If necessary, new unit tests have been added  
  - [ ] Assertions in unit tests use [Truth](https://truth.dev/), see existing tests
  - [ ] No JUnit 3 features are used (such as extending class `TestCase`)
  - [ ] If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed
- [ ] `mvn clean verify javadoc:jar` passes without errors
Add pull request template (#2326) 2023-02-27 22:52:57 +01:00			`<!--`
			`Thank you for your contribution!`
			`Please see the contributing guide: https://github.com/google/.github/blob/master/CONTRIBUTING.md`

			`Keep in mind that Gson is in maintenance mode. If you want to add a new feature, please first search for existing GitHub issues, or create a new one to discuss the feature and get feedback.`
			`-->`

			`### Purpose`
			`<!-- Describe the purpose of this pull request, for example which new feature it adds or which bug it fixes -->`
			`<!-- If this pull request closes a GitHub issue, please write "Closes #<issue>", for example "Closes #123" -->`


			`### Description`
			`<!-- If necessary provide more information, for example relevant implementation details or corner cases which are not covered yet -->`
			`<!-- If there are related issues or pull requests, link to them by referencing their number, for example "pull request #123" -->`



			`### Checklist`
			`<!-- The following checklist is mainly intended for yourself to verify that you did not miss anything -->`

Formatting follow-up (#2540) * Formatting follow-up - Adds formatting commits to .git-blame-ignore-revs so that they don't distract during Git blame - Restores hard line breaks in Troubleshooting.md using `\` instead of trailing spaces - Changes formatting of some string literals and comments - Fixes accidental Javadoc and comment issues introduced by manual changes of formatting commit - Fixes license header in $Gson$Types.java erroneously being a Javadoc comment and being reformatted - Slightly changes `JsonReader` `getPath` and `getPreviousPath` documentation to help Javadoc detect first sentence as summary * Remove `spotless:off` markers * Add empty line before comment * Check format for .github YAML files 2023-11-15 00:09:54 +01:00			`- [ ] New code follows the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html)\`
			This is automatically checked by `mvn verify`, but can also be checked on its own using `mvn spotless:check`.\
			Style violations can be fixed using `mvn spotless:apply`; this can be done in a separate commit to verify that it did not cause undesired changes.
Add pull request template (#2326) 2023-02-27 22:52:57 +01:00			- [ ] If necessary, new public API validates arguments, for example rejects `null`
			`- [ ] New public API has Javadoc`
			- [ ] Javadoc uses `@since $next-version$`
			(`$next-version$` is a special placeholder which is automatically replaced during release)
			`- [ ] If necessary, new unit tests have been added`
			`- [ ] Assertions in unit tests use [Truth](https://truth.dev/), see existing tests`
			- [ ] No JUnit 3 features are used (such as extending class `TestCase`)
			`- [ ] If this pull request fixes a bug, a new test was added for a situation which failed previously and is now fixed`
			- [ ] `mvn clean verify javadoc:jar` passes without errors