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

travis: Ensure READMEs are updated #629

Merged
merged 3 commits into from
Dec 4, 2017
Merged

travis: Ensure READMEs are updated #629

merged 3 commits into from
Dec 4, 2017

Conversation

petertseng
Copy link
Member

I don't feel like checking this manually.

Lifted straight from the Rust track.
exercism/rust#386

I don't feel like checking this manually.

Lifted straight from the Rust track.
exercism/rust#386
@petertseng
Copy link
Member Author

Note that although this will cause CI to fail if new exercises contain just a README that says "regenerate this README", the offer is still on the table that I can do this for others if desired. It just makes it easy for me to check whether I regenerated correctly.

@Average-user
Copy link
Member

Average-user commented Dec 4, 2017

Note that although this will cause CI to fail if new exercises contain just a README that says "regenerate this README", the offer is still on the table that I can do this for others if desired. It just makes it easy for me to check whether I regenerated correctly.

Couldn't you specify regenerate this as a valid README?

@petertseng
Copy link
Member Author

Couldn't you specify regenerate this as valid README?

I wish there were a way to make it so that it would let Travis succeeds BUT that I still get a reminder not to merge it unless I've actually regenerated. I don't have a way to do this yet, I don't think, so the danger if I let regenerate this pass Travis is that I'll then forget to regenerate.

@petertseng
Copy link
Member Author

The disadvantage is of course that it is hard for someone who submits "regenerate this" to tell whether the rest of the exercise has been completed correctly without errors because then they must read the test output. I acknowledge this is true and that I don't have a best solution for this yet, other than the two options of "regenerate the README" or "read the test output to see whether README is the only problem". This may mean I have to regenerate READMEs sooner in the review process, I can do that.

Also, since a previous reason I discouraged contributors generating READMEs is "even if you do it, I have to do it a second time just to make sure you did it right", now since CI is checking, it will be OK for contributors to generate READMEs since I will not have to do it a second time. So that's an option.

@petertseng petertseng merged commit 76ff1ce into exercism:master Dec 4, 2017
@petertseng petertseng deleted the readme-check branch December 4, 2017 13:58
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