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

ensure release and development directions are consistent #2554

Closed
munkm opened this issue Apr 21, 2020 · 4 comments · Fixed by #3813
Closed

ensure release and development directions are consistent #2554

munkm opened this issue Apr 21, 2020 · 4 comments · Fixed by #3813
Assignees
Labels

Comments

@munkm
Copy link
Member

munkm commented Apr 21, 2020

In preparing the yt-3.6 release and afterwards I noticed that we have differing documentation on releasing and development. I've included a few notes about it here. I will submit a PR with these fixes later, but please weigh in if you want to suggest anything.

Example1: ytep-0008 and the release documentation
see ytep-0008 and release documentation

  • ytep 0008 mentions the existence of a long-term support branch (with the naming convention yt-3.x and the release notes don't at all.
  • the ytep is very behind on the release managers and the dates of recent yt releases. This should be updated
  • the ytep is behind on the release information. this should be updated

Example 2: 'what constitutes a release' in ytep 0008 doesn't include info on conda-forge

  • this should be updated

Example 3: "requirements for code submission" section differs from governance
https://yt-project.org/doc/developing/developing.html#requirements-for-code-submission

  • this is mild but we don't mention the requirements for creating an issue in our governance at all. We also don't use closed issues to generate our release notes, so I think this requirement should probably be removed and we should add notes on the required number of approving reviewers. Alternatively, we could remove this section and link directly to the governance so we don't have to maintain these directions in two different places. But maybe the governance isn't the right place for it?
@triage-new-issues triage-new-issues bot added the triage Triage needed label Apr 21, 2020
@munkm munkm self-assigned this Apr 21, 2020
@munkm munkm added the docs label Apr 21, 2020
@triage-new-issues triage-new-issues bot removed the triage Triage needed label Apr 21, 2020
@cphyc cphyc added the yt-4.0 feature targeted for the yt-4.0 release label Jun 12, 2020
@neutrinoceros
Copy link
Member

So after a discussion you and I had on #2690, I realised that the dev guide currently doesn't have a "How to deprecate and remove features in yt" section. Such a section would be really helpful to ensure consistency in the procedure and maybe provide insight on how we keep track of stuff that's targeted for deprecation.
Do you think this belongs here ?

@munkm
Copy link
Member Author

munkm commented Nov 10, 2020

I think that is definitely relevant to the broader issues of the developer guide. If we do want the release manager to be the dedicated person to make sure all deprecations are removed on a timetable then it's absolutely something that should be in this issue.

@munkm munkm removed the yt-4.0 feature targeted for the yt-4.0 release label Nov 13, 2020
@neutrinoceros
Copy link
Member

I've added instructions for closing a deprecation cycle in #3806

@neutrinoceros
Copy link
Member

neutrinoceros commented Feb 16, 2022

Example 1 and Example 2 are handled in yt-project/ytep#22

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

Successfully merging a pull request may close this issue.

4 participants