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
30 changes: 30 additions & 0 deletions doc/contributing/sharing-project-news.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
# Sharing project news

The project, supported by the next-10 team, aims to make it easy
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
to share project news with those who publish newsletters
that cover Node.js.

The project's approach is as follows:

mhdawson marked this conversation as resolved.
Show resolved Hide resolved
* 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

repo for news related to Node.js core.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
* Teams/groups can create a "what's new in YYYY" issue in one or more of their
repositories. As an example see
[What's new in the Node-API and node-addon-api world? - 2023 version](https://github.com/nodejs/abi-stable-node/issues/446).
* Collaborators periodically add news as additional comments on these
issues throughout the year.
* At the end of each year the issue is closed and if appropriate a
new one is created.
* A list of these documents is maintained in the section below as a
quick way to find them.
* The next-10 team reaches out to teams/groups on an ad hoc basis
to ensure teams know about the option for sharing news.
* The next-10 team reaches out to those who publish newsletters ad hoc
to let them know about this approach and how they can find the updates.

We trust/expect collaborators to post project related news versus news
that promotes a specific company or commercial interest.

## Teams doing updates

* [node-api/node-addon-api](https://github.com/nodejs/abi-stable-node/issues/446).