Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Wiki
  • Pull Request Checklist

Pull Request Checklist · Changes

Page history
Extend Review section authored Aug 15, 2018 by Jérémie Bresson's avatar Jérémie Bresson
Hide whitespace changes
Inline Side-by-side
Pull-Request-Checklist.md
View page @ 6b035162
...@@ -21,6 +21,19 @@ TODO: add more details about this. ...@@ -21,6 +21,19 @@ TODO: add more details about this.
It should be clear what the PR is changing (link to an issue, explanation, small OpenAPI Spec to reproduce the issue). It should be clear what the PR is changing (link to an issue, explanation, small OpenAPI Spec to reproduce the issue).
Try to have a title that summarize the change. Remember that the PR titles are used in the release notes, so it is important to invest some effort. Good titles:
* Include the generator name, or the domain in brackets `[JAXRS-spec]`, `[JAVA][Rest-assured]`, `[C++][Restbed]`, `[docs]`, `[CI]`...
* Include a short summary of the change
The description is also an important aspect of the PR. It should provide more information about what the change brings:
* If the change introduce a new option, explain the possible values and what is the default
* If an issue exists that describes the problem, add a link to it.
* ...
Remember that the PR description will be the first place where developer look when they want to understand the intention behind a change.
Unit tests are always great. Unit tests are always great.
Test locally if needed. Test locally if needed.
......
Clone repository
  • API client generator HOWTO
  • Building your own Templates
  • Customizing client code generation
  • FAQ
  • Git Branches
  • Home
  • How to add a generator for a new language or framework
  • Integration Tests
  • Migration Guide
  • Mustache Template Variables
  • Pull Request Checklist
  • Release Checklist
  • Samples folder
  • Server stub generator HOWTO
  • Vendor Extensions
View All Pages