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

Updated README.md with revision history and cleanup. #29

Merged
merged 2 commits into from
May 8, 2020

Conversation

cprotopa
Copy link
Contributor

@cprotopa cprotopa commented May 4, 2020

The main purpose of this pull request is to provide a list of revisions of the code, since this is not documented elsewhere. Other small adjustments were made, such as in the list of used packages, the example, and addition of references.
So from now on it would be nice if any pull request would be accompanied by the appropriate change in the README.md file. To be able to add the correct date and link to pull request, this needs to be done after merging, so perhaps the person merging the request should do it. Any better suggestion?
@Mathadon , @SilkeVerbruggen, are there any comments/objections?

@Mathadon
Copy link
Member

Mathadon commented May 7, 2020

Updating the readme with the correct date requires a second merge, which is cumbersome. IDEAS models also have a revision note in the models and there the date of the change is included, not the change of the merge. I'd suggest you do the same here?

@cprotopa
Copy link
Contributor Author

cprotopa commented May 7, 2020

In a way, the date of merge can be useful for users to figure out what they have missed since the last time they pulled or downloaded (not everybody is fully immersed in versioning principles and just care about that). Also, in some cases the change might only be merged quite a while after originally made. Furthermore, I think adding the link to the pull request could help have a good view on the changes.
But I agree it should be more a responsibility of the person making the change to also write the revision history, thus ideally include it in the pull request to start with.

Thus I would conclude that the revision history should be altered together with the change with at least a provisional date of submitting the change. Potential later refinement with addition of link will be up to the repository responsible, whoever that might be!

Anyway, for changes that I listed up till now I will keep the merge dates, because that's what asks for the least work for the moment.

@cprotopa cprotopa merged commit da9e6e5 into master May 8, 2020
@cprotopa cprotopa deleted the UpdateREADME branch May 8, 2020 16:01
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