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

Start work on revised specification in file name OmniSpecification -- move spec out of README file #334

Open
msgilligan opened this issue Oct 25, 2019 · 4 comments
Assignees
Milestone

Comments

@msgilligan
Copy link
Member

msgilligan commented Oct 25, 2019

I think README should be an overview of the repository as is the standard/best practice on Github. And the specification should be in a file named OmniSpecification or something similar.

One reason for doing this is that as we clean up the specification, we're very likely to split it into multiple documents and the README can serve as an index that "points to" those documents.

@CraigSellars @achamely @marvgmail @dexX7 Thoughts?

@msgilligan msgilligan self-assigned this Mar 26, 2020
@msgilligan
Copy link
Member Author

msgilligan commented Mar 26, 2020

The current plan is:

  1. Update specification version in existing README.adoc document to v0.6 - PR Update version number to v0.6 #341
  2. Create a new document OmniSpecification.adoc with a new table of contents and version number of v0.7 (and begin the process of adding/updating content in this document) - PR Add new Specification (to be v0.7) document in outline form #342
  3. Move README.adoc to OmniSpecification-v0.6.adoc and update the README to point at both the old and new specifications during the transition period.
  4. Complete version 0.7 of the specification
  5. Update the README to reflect the new specification and remove the link to the old version (the spec itself can have a link to the old version in an appendix)

@msgilligan
Copy link
Member Author

@adam @marvgmail - the above plan is basically what we discussed at today's meeting.

@CraigSellars @dexX7 -- does the above plan sound reasonable?

@msgilligan msgilligan changed the title Rename specification file from README to OmniSpecification Start work on revised specification in file name OmniSpecification -- move spec out of README file Mar 26, 2020
@msgilligan msgilligan added this to the Version 0.7 milestone Mar 26, 2020
@marvgmail
Copy link

Looks like a reasonable plan

@dexX7
Copy link
Member

dexX7 commented Mar 31, 2020

Sounds good!

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

No branches or pull requests

4 participants