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

docs: Add roadmap document for 2019 into 2020 #567

Merged
merged 2 commits into from
Sep 26, 2019

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Sep 17, 2019

Description

Resolves #563

This is a document form of Issue #561 which will allow developers to mark off in the ROADMAP document how their PR contributes to it. As it is possible for the checklist in Issue #561 to get out of sync with development this should help serve as a source of "truth" about development status.

Use:
For any PR that a developer completes that is associated with the pyhf 2019 into 2029 Roadmap project they mark the item in the roadmap that they have completed in the PR, or amend the roadmap. Once it is merged in they can amend the Issue #561 to reflect this for easier web viewing of developers and non-developers.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* docs: Add document form of Issue #561 for roadmap of pyhf development.
   - This will act as the "truth" state of the roadmap that the GitHub Issue can be updated from.

@matthewfeickert matthewfeickert added the docs Documentation related label Sep 17, 2019
@matthewfeickert matthewfeickert self-assigned this Sep 17, 2019
@coveralls
Copy link

coveralls commented Sep 17, 2019

Coverage Status

Coverage remained the same at 93.48% when pulling d2cb8aa on docs/add-ROADMAP into c3f9a70 on master.

@lukasheinrich
Copy link
Contributor

lukasheinrich commented Sep 18, 2019

@matthewfeickert
Copy link
Member Author

ROADMAP.md in the root seems like a common pattern

I'm not directly against it, but it seemed more like documentation to me and there doesn't seem to be as clear of an agreed upon path to put it in as README or CONTRIBUTING. I'm happy to move it though if you both prefer it elsewhere.

@matthewfeickert matthewfeickert marked this pull request as ready for review September 25, 2019 04:19
Copy link
Contributor

@lukasheinrich lukasheinrich left a comment

Choose a reason for hiding this comment

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

LGTM

This is a document form of Issue 561 which will allow developers to mark
off in the ROADMAP document how their PR contributes to it.
As it is possible for the checklist in Issue 561 to get out of sync with
developement this should help serve as a source of "truth" about
developement status.
The roadmap will be treated like a normal version controlled file and be
updated and changed as the plans for the project move
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add ROADMAP.md to help keep track of Roadmap?
4 participants