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

[feature] Add a roadmap issue #583

Closed
laurentsimon opened this issue Jul 19, 2022 · 6 comments
Closed

[feature] Add a roadmap issue #583

laurentsimon opened this issue Jul 19, 2022 · 6 comments
Labels
type:discussion A point of discussion type:documentation Improvements or additions to documentation

Comments

@laurentsimon
Copy link
Collaborator

It would be useful to have an issue with a roadmap, to let people know what we're working on in the next 3-6 months.

@laurentsimon laurentsimon added type:feature New feature or request status:triage Issue that has not been triaged labels Jul 19, 2022
@ianlewis
Copy link
Member

Depending on what we think the roadmap should have in it, one easy way to communicate what we're working on is to use milestones.

Github Projects are also a way do to it but requires more effort to keep up to date.

@ianlewis ianlewis added type:documentation Improvements or additions to documentation type:discussion A point of discussion and removed status:triage Issue that has not been triaged type:feature New feature or request labels Jul 20, 2022
@laurentsimon
Copy link
Collaborator Author

laurentsimon commented Jul 20, 2022

Thanks for the feedback. Do you think just an issue that lists the milestone would be enough? I wonder if people look at milestones directly, or whether having an issue (or a discussion or a project) would help give more visibility for someone who visits the repo. I know people tends to look at issues when visiting a repo, for example.

@ianlewis
Copy link
Member

Thanks for the feedback. Do you think just an issue that lists the milestone would be enough? I wonder if people look at milestones directly, or whether having an issue (or a discussion or a project) would help give more visibility for someone who visits the repo. I know people tends to look at issues when visiting a repo, for example.

Yeah, I'm not sure what folks would really want in practice. Milestones can answer the question "What are we working on in the next 3-6 months", but you're right that it doesn't have the opportunity for discussion. I think milestones are easy to keep updated and should be good enough for now if we link to them on the README to indicate that we are using them. Folks can always create issues if they want something.

We can put out more high level roadmap docs or something if there is need for them. I just feel like these docs often are super high level and don't really say much. And when they do they aren't really updated.

Some example roadmaps I found:

  • Kubernetes sig-release
    • other sigs don't seem to have roadmaps? or I couldn't find any recent ones. They seem to only put out annual reports after the fact
  • sigstore roadmap - Last updated in November 2021
  • etcd used to have one but they deleted it.

Do you have any other examples of good roadmaps created by other projects?

@laurentsimon
Copy link
Collaborator Author

There's also SLSA's roadmap here slsa-framework/slsa#384
We don't need this level of details. I was merely trying to make our milestones more visible. The issue you created is good enough for now. I also added a list of builders in the README with (WIP, etc). I think this also helps show visitors what they can expect in the future

@ianlewis
Copy link
Member

Yeah, maybe if we start working with the new tooling working group more we can start aligning with and incorporating our work in their roadmap.

@ianlewis
Copy link
Member

ianlewis commented Jan 6, 2023

We are tracking our roadmap via milestones so I'm going to close this.

@ianlewis ianlewis closed this as completed Jan 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:discussion A point of discussion type:documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants