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, meta: organize contributing to Node-API guide #53243

Merged
merged 9 commits into from
Jun 22, 2024

Conversation

RedYetiDev
Copy link
Member

This pull request restructures the Node-API guide by segmenting it into sections. The current guide, with its lengthy list, might appear intimidating and strict to contributors. However, by categorizing the list into subsections, contributors can more easily pinpoint the necessary steps for a successful contribution.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/node-api
  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Jun 1, 2024
@RedYetiDev RedYetiDev added meta Issues and PRs related to the general management of the project. node-api Issues and PRs related to the Node-API. labels Jun 1, 2024
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
RedYetiDev and others added 3 commits June 8, 2024 07:57
Co-authored-by: Gabriel Schulhof <[email protected]>
Co-authored-by: Gabriel Schulhof <[email protected]>
Co-authored-by: Gabriel Schulhof <[email protected]>
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
doc/contributing/adding-new-napi-api.md Outdated Show resolved Hide resolved
@benjamingr benjamingr added the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 22, 2024
@nodejs-github-bot nodejs-github-bot added commit-queue-failed An error occurred while landing this pull request using GitHub Actions. and removed commit-queue Add this label to land a pull request using GitHub Actions. labels Jun 22, 2024
@nodejs-github-bot
Copy link
Collaborator

Commit Queue failed
- Loading data for nodejs/node/pull/53243
✔  Done loading data for nodejs/node/pull/53243
----------------------------------- PR info ------------------------------------
Title      doc, meta: organize contributing to Node-API guide (#53243)
   ⚠  Could not retrieve the email or name of the PR author's from user's GitHub profile!
Branch     RedYetiDev:patch-40 -> nodejs:main
Labels     doc, meta, node-api
Commits    9
 - doc, meta: organize contributing to Node-API guide
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
 - Update adding-new-napi-api.md
Committers 1
 - GitHub 
PR-URL: https://github.com/nodejs/node/pull/53243
Reviewed-By: Gabriel Schulhof 
Reviewed-By: Chengzhong Wu 
------------------------------ Generated metadata ------------------------------
PR-URL: https://github.com/nodejs/node/pull/53243
Reviewed-By: Gabriel Schulhof 
Reviewed-By: Chengzhong Wu 
--------------------------------------------------------------------------------
   ℹ  This PR was created on Sat, 01 Jun 2024 17:45:31 GMT
   ✔  Approvals: 2
   ✔  - Gabriel Schulhof (@gabrielschulhof): https://github.com/nodejs/node/pull/53243#pullrequestreview-2106066624
   ✔  - Chengzhong Wu (@legendecas) (TSC): https://github.com/nodejs/node/pull/53243#pullrequestreview-2133496697
   ✔  Last GitHub CI successful
   ℹ  Green GitHub CI is sufficient
--------------------------------------------------------------------------------
   ✔  No git cherry-pick in progress
   ✔  No git am in progress
   ✔  No git rebase in progress
--------------------------------------------------------------------------------
- Bringing origin/main up to date...
From https://github.com/nodejs/node
 * branch                  main       -> FETCH_HEAD
✔  origin/main is now up-to-date
- Downloading patch for 53243
From https://github.com/nodejs/node
 * branch                  refs/pull/53243/merge -> FETCH_HEAD
✔  Fetched commits as cba170d8833d..05b5c1ef3e7a
--------------------------------------------------------------------------------
[main 06143e6b08] doc, meta: organize contributing to Node-API guide
 Author: Aviv Keller <[email protected]>
 Date: Sat Jun 1 13:42:54 2024 -0400
 1 file changed, 55 insertions(+), 61 deletions(-)
[main 3f31b28da0] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Sat Jun 8 07:57:08 2024 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 673df66be9] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Sat Jun 8 07:57:13 2024 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 1489b9f042] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Sat Jun 8 07:57:19 2024 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 3b697135c3] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Mon Jun 17 11:23:21 2024 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main 2b33087040] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Mon Jun 17 11:25:22 2024 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main aa1d7d744c] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Mon Jun 17 11:25:32 2024 -0400
 1 file changed, 1 insertion(+), 1 deletion(-)
[main b1f2288665] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Mon Jun 17 11:52:52 2024 -0500
 1 file changed, 2 insertions(+), 1 deletion(-)
[main 32d67ae73a] Update adding-new-napi-api.md
 Author: Aviv Keller <[email protected]>
 Date: Tue Jun 18 08:27:03 2024 -0500
 1 file changed, 9 deletions(-)
   ✔  Patches applied
There are 9 commits in the PR. Attempting autorebase.
Rebasing (2/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
doc, meta: organize contributing to Node-API guide

PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD 7449a04de7] doc, meta: organize contributing to Node-API guide
Author: Aviv Keller [email protected]
Date: Sat Jun 1 13:42:54 2024 -0400
1 file changed, 55 insertions(+), 61 deletions(-)
Rebasing (3/18)
Rebasing (4/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

Co-authored-by: Gabriel Schulhof [email protected]
PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD a7586501bb] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Sat Jun 8 07:57:08 2024 -0400
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (5/18)
Rebasing (6/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

Co-authored-by: Gabriel Schulhof [email protected]
PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD c9cfacff77] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Sat Jun 8 07:57:13 2024 -0400
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (7/18)
Rebasing (8/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

Co-authored-by: Gabriel Schulhof [email protected]
PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD 8fbdfded40] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Sat Jun 8 07:57:19 2024 -0400
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (9/18)
Rebasing (10/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

Co-authored-by: Chengzhong Wu [email protected]
PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD bfcc986664] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Mon Jun 17 11:23:21 2024 -0400
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (11/18)
Rebasing (12/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

Co-authored-by: Chengzhong Wu [email protected]
PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD 9540c3a7e0] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Mon Jun 17 11:25:22 2024 -0400
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (13/18)
Rebasing (14/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

Co-authored-by: Chengzhong Wu [email protected]
PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD 1851d1e403] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Mon Jun 17 11:25:32 2024 -0400
1 file changed, 1 insertion(+), 1 deletion(-)
Rebasing (15/18)
Rebasing (16/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD 987d3e33c6] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Mon Jun 17 11:52:52 2024 -0500
1 file changed, 2 insertions(+), 1 deletion(-)
Rebasing (17/18)
Rebasing (18/18)

Executing: git node land --amend --yes
--------------------------------- New Message ----------------------------------
Update adding-new-napi-api.md

PR-URL: #53243
Reviewed-By: Gabriel Schulhof [email protected]
Reviewed-By: Chengzhong Wu [email protected]

[detached HEAD b6402349aa] Update adding-new-napi-api.md
Author: Aviv Keller [email protected]
Date: Tue Jun 18 08:27:03 2024 -0500
1 file changed, 9 deletions(-)

Successfully rebased and updated refs/heads/main.

ℹ Add commit-queue-squash label to land the PR as one commit, or commit-queue-rebase to land as separate commits.

https://github.com/nodejs/node/actions/runs/9626875573

@benjamingr benjamingr added commit-queue Add this label to land a pull request using GitHub Actions. commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. and removed commit-queue-failed An error occurred while landing this pull request using GitHub Actions. labels Jun 22, 2024
@nodejs-github-bot nodejs-github-bot removed the commit-queue Add this label to land a pull request using GitHub Actions. label Jun 22, 2024
@nodejs-github-bot nodejs-github-bot merged commit 69abdcd into nodejs:main Jun 22, 2024
25 checks passed
@nodejs-github-bot
Copy link
Collaborator

Landed in 69abdcd

@RedYetiDev RedYetiDev deleted the patch-40 branch June 22, 2024 19:02
targos pushed a commit that referenced this pull request Jun 25, 2024
PR-URL: #53243
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
targos pushed a commit that referenced this pull request Jun 25, 2024
PR-URL: #53243
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
PR-URL: #53243
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
marco-ippolito pushed a commit that referenced this pull request Jul 19, 2024
PR-URL: #53243
Reviewed-By: Gabriel Schulhof <[email protected]>
Reviewed-By: Chengzhong Wu <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
commit-queue-squash Add this label to instruct the Commit Queue to squash all the PR commits into the first one. doc Issues and PRs related to the documentations. meta Issues and PRs related to the general management of the project. node-api Issues and PRs related to the Node-API.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants