Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TRIVIAL] docs(pull_request_template): add API Impact section #4757

Merged
merged 2 commits into from
Oct 18, 2023

Conversation

intelliot
Copy link
Collaborator

@intelliot intelliot commented Oct 10, 2023

High Level Overview of Change

Any PR which impacts the API should document those API changes in API-CHANGELOG.md.

That documentation should be added directly, as part of the relevant PR itself. PR authors should write (at least) the initial draft of that API-CHANGELOG entry and push that change to their PR branch so that the documentation change is made alongside the code changes proposed by the PR.

Context of Change

A number of API changes have been made without updating API-CHANGELOG.md.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (non-breaking change that only restructures code)
  • Tests (You added tests for code that already exists, or your new feature included in this PR)
  • Documentation Updates
  • Release

[TRIVIAL]: modifies markdown template only; does not touch any C++ code

@Bronek
Copy link
Collaborator

Bronek commented Oct 11, 2023

how about adding Chore option above Release (i.e. something that only impacts developer experience e.g. .gitignore, formatting etc.)

@intelliot
Copy link
Collaborator Author

added Chore option above Release (i.e. something that only impacts developer experience e.g. .gitignore, formatting etc.)

@intelliot intelliot added the Documentation README changes, code comments, etc. label Oct 16, 2023
@intelliot intelliot added this to the 2.0 milestone Oct 16, 2023
@intelliot intelliot changed the title docs(pull_request_template): add API Impact section [TRIVIAL] docs(pull_request_template): add API Impact section Oct 18, 2023
@intelliot intelliot merged commit be6ac7e into develop Oct 18, 2023
32 checks passed
@intelliot intelliot deleted the api-impact-pr-template branch October 19, 2023 05:58
sophiax851 pushed a commit to sophiax851/rippled that referenced this pull request Jun 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation README changes, code comments, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants