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

doc: document process for sharing project news #47189

Closed
wants to merge 10 commits into from

Conversation

mhdawson
Copy link
Member

Fixes: nodejs/TSC#1333

Signed-off-by: Michael Dawson <mdawson@devrus.com>
@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 21, 2023
mhdawson and others added 6 commits March 22, 2023 16:30
Co-authored-by: mscdex <mscdex@users.noreply.github.com>
Co-authored-by: Gireesh Punathil <gpunathi@in.ibm.com>
Co-authored-by: mscdex <mscdex@users.noreply.github.com>
Co-authored-by: mscdex <mscdex@users.noreply.github.com>
Co-authored-by: mscdex <mscdex@users.noreply.github.com>

The project's approach is as follows:

* The project will create one "What's new in YYYY" issue in the `nodejs/node`
Copy link
Member

@Trott Trott Mar 24, 2023

Choose a reason for hiding this comment

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

An issue seems like the wrong tool for the job. Would a GitHub discussion item be better?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm if ok if a discussion item is better for the core repo. Updating

Co-authored-by: Rich Trott <rtrott@gmail.com>
@mhdawson
Copy link
Member Author

@Trott believe I've addressed your comments/suggestions.

The project's approach is as follows:

* The project will create one "What's new in YYYY" discussion item in
the `nodejs/node` repo for news related to Node.js core.
Copy link
Member

Choose a reason for hiding this comment

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

I think it might be better to use a separate repo for these news. In this way, publications could subscribe to the notifications on that repository to receive the updates.

Copy link
Member Author

Choose a reason for hiding this comment

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

That could make it easier for publications but the goal is to make it easy for the teams and the project both in terms of workflow and discoverability. In the case of the node-api team looking for an issue in a different repo would be more work due to the way we use a milestone to review work each week.

Even if there was a separate repo the ask was not that a new issue be created for each piece of news, only update an existing issue/discussion so once the publication subscribes to an issue I don't think it will be any different in respect to notifications.

Therefore I think using an issue/discussion item in the existing repos is better.

Copy link
Member

Choose a reason for hiding this comment

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

ok!!

mhdawson added a commit that referenced this pull request Mar 29, 2023
Fixes: nodejs/TSC#1333

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #47189
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@mhdawson
Copy link
Member Author

Landed in 67660e8

@mhdawson mhdawson closed this Mar 29, 2023
RafaelGSS pushed a commit that referenced this pull request Apr 5, 2023
Fixes: nodejs/TSC#1333

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #47189
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
@RafaelGSS RafaelGSS mentioned this pull request Apr 6, 2023
RafaelGSS pushed a commit that referenced this pull request Apr 6, 2023
Fixes: nodejs/TSC#1333

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #47189
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
RafaelGSS pushed a commit that referenced this pull request Apr 7, 2023
Fixes: nodejs/TSC#1333

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #47189
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
danielleadams pushed a commit that referenced this pull request Jul 6, 2023
Fixes: nodejs/TSC#1333

Signed-off-by: Michael Dawson <mdawson@devrus.com>

PR-URL: #47189
Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com>
Reviewed-By: Chengzhong Wu <legendecas@gmail.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Sharing project news
10 participants