Skip to content

Commit 2fcb1bd

Browse files
authored
Update the contributing doc (NuGet#3100)
1 parent ed3ad1c commit 2fcb1bd

File tree

2 files changed

+10
-3
lines changed

2 files changed

+10
-3
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# Contributing
2+
13
No contribution is too big or too small.
24

35
1. Visit the page to edit in the [NuGet documentation](https://learn.microsoft.com/nuget/), then click the **Edit** button on the top right. This brings you to the appropriate markdown page in the repo.

README.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@ No contribution is too big or too small.
2626
1. Relative links to other pages in this docset should be in the form `../<folder>/<topic-file>.md` including the training `.md`. If you're linking to another topic in the same folder, then `../<folder>/` can be omitted. When using anchors, always remember to include the `.md` before the `#`.
2727
1. When using external links, especially to Microsoft Learn, omit any language tag like "en-us" so that a reader in another language lands on a target page in that same language if it's available.
2828
1. When you're done, enter a commit message below, and click **Propose file change**.
29-
1. Send a pull request for your change. We review PRs on a regular basis.
29+
1. Send a pull request for your change. Review requests are automatic and we review PRs on a regular basis.
3030
1. Thank you!
3131

32-
> **If your content is not live yet, there is a manual `main` -> `live` pull request that is needed to pick-up the changes. Please create a PR or ping a content owner to do so on your behalf.**
33-
3432
If you're creating a new topic, keep the following in mind as well:
3533

3634
1. Always place the new topic in an appropriate subfolder, and follow the conventions for filenames as you see them used here.
@@ -58,6 +56,13 @@ If you're creating a new topic, keep the following in mind as well:
5856
| reference | Any reference-type article that isn't auto-generated. |
5957
| article | Use for community-contributed content (that is, anything from outside the engineering team or the content team at Microsoft. |
6058

59+
## Merging to the live branch
60+
61+
NuGet team members have permissions to merge to `live` branch manually, at their own discretion.
62+
Otherwise, a regular (about once a month) Reverse Integration (RI) will be performed from `main` -> `live` branch.
63+
Based on the urgency of the docs, this may happen frequently.
64+
It is very important that the RI pull requests are *merged* and *not squashed*.
65+
6166
## Conventions
6267

6368
In general, if you don't see something described here, look in editing markdown files for examples, with the exception of files in the Release Notes which are legacy content and haven't been as thoroughly edited.

0 commit comments

Comments
 (0)