Skip to content

Adding a revert policy #176

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

Merged
merged 1 commit into from
Oct 10, 2016
Merged

Conversation

RichardLitt
Copy link
Member

This comes directly from ipfs/kubo#3166, and @Kubuxu. I have added it here and edited it slightly for language.


When some change is introduced, and we decide that it isn't beneficial and/or it causes problems, we need to revert it.

To make the review process and the changes easier, use git's `revert` command to revert some changes.
Copy link
Member

Choose a reason for hiding this comment

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

revert those changes

To make the review process and the changes easier, use git's `revert` command to revert some changes.

This suits a few purposes. First, it is much easier to see if some change was reverted by just looking into the history of the file. Imagine a commit with the title: _Add feature C_. There are many ways one could form the title for a commit reverting it, but by using `git revert`, it will be _Revert: "Add feature C"_ and thus very clear.
Second, by using `git revert` we are sure that all changes were reverted. It is much easier to star again for state 0 and apply changes on it, than try to see if some transformation transforms state 1 to state 0.
Copy link
Member

Choose a reason for hiding this comment

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

s/to star/to start

This comes directly from ipfs/kubo#3166, and @Kubuxu. I have added it here and edited it slightly for language.
@RichardLitt RichardLitt force-pushed the feat/add-revert-changes-section branch from c5f135e to ac0090b Compare September 20, 2016 01:31
@RichardLitt
Copy link
Member Author

@Kubuxu Approve changes?

@Kubuxu
Copy link
Member

Kubuxu commented Oct 10, 2016

Yup LGTM.

@RichardLitt RichardLitt merged commit 4d84cd8 into master Oct 10, 2016
@RichardLitt RichardLitt deleted the feat/add-revert-changes-section branch October 10, 2016 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants