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

Adjust the readme intro for the Beta1 release #167

Closed
5 of 6 tasks
webmat opened this issue Nov 5, 2018 · 1 comment
Closed
5 of 6 tasks

Adjust the readme intro for the Beta1 release #167

webmat opened this issue Nov 5, 2018 · 1 comment

Comments

@webmat
Copy link
Contributor

webmat commented Nov 5, 2018

We'll need to adjust the readme for this first release:

  • Tone down the chances for breaking changes. The point of Beta1 is to start guaranteeing more backwards compatibility. But since it's Beta1, we shouldn't guarantee 100% necessarily yet.
  • We should link to the specific git tag right in the intro, to make it easy to browse the repo as of the Beta1 release.
  • Warning that in cases of discrepancies between the readme and schema.csv or template.json, the readme should prevail.
    • This is a temporary situation. Ideally all would be in line, but they won't be yet, at the time of Beta1
  • Output the new version instead of 0.1.0. By the way, what should the Beta1 version be?
  • Mention the two temporary removals (Temporarily remove the http object... #171 and Temporarily remove the user_agent field set... #172)?
@webmat
Copy link
Contributor Author

webmat commented Nov 6, 2018

I haven't seen mentions of breaking changes that needed to be toned down (referring to my first subtask above).

Other than this point, #174 is a first attempt at what this release could look like, from a readme/changelog point of view.

#173 will also be important for people to be able to navigate the markdown renderings directly on Github. Otherwise clicking some links brings them out of a git tag and back to the master repository, which is constantly in flux.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant