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

docs: describe the process for making breaking changes #2103

Merged
merged 1 commit into from
Dec 3, 2018

Conversation

bajtos
Copy link
Member

@bajtos bajtos commented Nov 30, 2018

In the light of #2078, which is likely to introduce a semver-major change, I feel it's important to have some documentation (a kind of a check-list) capturing all steps to take before making the actual semver-major release.

@strongloop/loopback-maintainers please take a look and let me know what you think about my proposal.

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

@bajtos bajtos added Docs Contributing Things making it easier and more pleasant to contribute to LoopBack labels Nov 30, 2018
@bajtos bajtos self-assigned this Nov 30, 2018
@bajtos bajtos requested a review from a team November 30, 2018 13:14
@Yaty
Copy link
Contributor

Yaty commented Nov 30, 2018

👍

I think we should also have a section like the Node.js project : When Breaking Changes Actually Break Things

@bajtos
Copy link
Member Author

bajtos commented Nov 30, 2018

I think we should also have a section like the Node.js project : When Breaking Changes Actually Break Things

Thank you for the link, I was not aware of this resource.

To be honest, I don't know how to apply it to LoopBack. We don't keep master and Current separated, the master branch is the Current version. What do you @Yaty propose? Can you perhaps open a follow-up pull request with the content you have in mind, once my PR is landed?

@Yaty
Copy link
Contributor

Yaty commented Nov 30, 2018

I was thinking about the case where some unplanned breaking changes where pushed in master and published in NPM and what to do about those (revert ? retroactively label them as breaking changes ? ...).
I will open a PR about this after this one lands to discuss about the possible outcomes :)

@bajtos
Copy link
Member Author

bajtos commented Nov 30, 2018

I was thinking about the case where some unplanned breaking changes where pushed in master and published in NPM and what to do about those (revert ? retroactively label them as breaking changes ? ...).

The master branch is configured as protected on GitHub, only repo admins can push to master directly. Everybody else is required to open a pull request, this is enforced by GitHub at git level. Process-wise, every change should go through a pull request review, which should hopefully catch them.

Of course, there is always a possibility that a breaking change is unnoticed by PR reviewers and gets landed on master.

I will open a PR about this after this one lands to discuss about the possible outcomes :)

Awesome!

Copy link
Member

@dhmlau dhmlau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. I believe it's "backward compatibility" instead of "backwards compatibility".

docs/site/DEVELOPING.md Outdated Show resolved Hide resolved
docs/site/DEVELOPING.md Outdated Show resolved Hide resolved
@bajtos bajtos force-pushed the docs/making-breaking-changes branch from 1aa12e3 to 970a4a1 Compare December 3, 2018 09:12
@bajtos bajtos merged commit 2a6437d into master Dec 3, 2018
@bajtos bajtos deleted the docs/making-breaking-changes branch December 3, 2018 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Contributing Things making it easier and more pleasant to contribute to LoopBack Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants