Skip to content

Commit 89a7104

Browse files
committed
docs: add maintainer onboarding and publish docs
Signed-off-by: dhmlau <dhmlau@ca.ibm.com>
1 parent f18ebb8 commit 89a7104

File tree

7 files changed

+106
-1
lines changed

7 files changed

+106
-1
lines changed

docs/onboard-maintainer/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Maintainer onboarding
2+
3+
- If you identify a community member who fits to be a LoopBack maintainer, go through the [nomination process](maintainer-nomination.md)
4+
- Once approved, send an email to invite the community member to the maintainer team. [This email template for maintainer invitation](maintainer-invitation-template.md) can be used as a reference
5+
- Once accepted, follow the steps in the [maintainer onboarding document](maintainer-onboarding.md)
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Email template to invite potential maintainer
2+
3+
4+
### Email subject
5+
6+
Invitation to join the team of LoopBack maintainers
7+
8+
### Email body
9+
10+
Hi _name_,
11+
12+
We really appreciate the work you have contributed to _repo_ and would like to invite you to join our team of LoopBack maintainers.
13+
14+
15+
What would that mean for you:
16+
17+
- Greater influence on LoopBack's future direction
18+
19+
- Commit (write) rights to _repo_
20+
21+
- Ability to review and land pull requests, edit/categorize/close issues
22+
23+
- Access to a private Slack channel for LoopBack maintainers
24+
25+
If there is anything else that would make you a more successful maintainer, then let me know and I'll do my best to arrange it for you.
26+
27+
 
28+
In return we ask you to follow the existing processes, see http://loopback.io/doc/en/contrib/Governance.html. This means mostly:
29+
30+
- Be nice to others
31+
32+
- Try to reach consensus with other maintainers before making a decision
33+
34+
- Always use pull requests to make code changes
35+
36+
- Honour our current conventions, see http://loopback.io/doc/en/contrib/triaging-pull-requests.html and http://loopback.io/doc/en/contrib/style-guide.html (but feel free to propose changes to these conventions!)
37+
38+
- To avoid possible confusion, we don't have any specific requirements about the amount of time you should spend on the project - just keep working on things that you find important to you, in a pace that suits you. We may ask you to take a look at issues and pull requests related to code you contributed yourself. This is primarily to make sure we don't accidentally break your stuff because of our lack of knowledge, and you can always excuse yourself :)
39+
40+
What do you think?
File renamed without changes.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Maintainer onboarding checklist
2+
3+
Once a new maintainer accepted to join the maintainers team
4+
- add them to the private `#loopback-maintainers` Slack channel
5+
- add them to the [loopback-maintainers team](https://github.com/orgs/loopbackio/teams/loopback-maintainers) in GitHub. If they are part of Technical Steering Committee as well, add them to [loopback-tsc team](https://github.com/orgs/loopbackio/teams/loopback-tsc).
6+
- add them to the [loopback-openjsf team](https://www.npmjs.com/settings/loopback-openjsf/members) on npmjs.com for publishing npm modules.
7+
- update the [README](https://github.com/loopbackio/loopback-next/blob/master/README.md#team) with the new member

docs/publish-modules/README.md

Whitespace-only changes.

docs/publish-modules.md renamed to docs/publish-modules/publish-lb4-modules.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Publish LoopBack Modules
1+
# Publish LoopBack Modules in loopback-next repos
22

33
## Pre-requisite
44

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
# Publish other LoopBack modules
2+
3+
## Pre-requisite
4+
5+
1. You need to be on the [`loopback-openjsf` organization on npmjs](https://www.npmjs.com/settings/loopback-openjsf/teams), and part of the `developers` team. Contact the TSC memebers for access.
6+
7+
2. Install [`strong-tools`](https://www.npmjs.com/package/strong-tools), we'll be using the `slt-release` command to publish.
8+
9+
## Steps to publish
10+
11+
1. git clone the repo
12+
2. log into npmjs using `npm login` command
13+
3. run `slt-release -up <major/minor/patch>`. To determine which of major/minor/patch to choose, see https://semver.org/
14+
4. after the release, you can run `npm view <module-name>` to check.
15+
5. when you're done, as best practice, logout of NPM using `npm logout` to mitigate against accidental publishing and token stealing.
16+
17+
18+
19+
## How to revert the release
20+
In case you want to revert the release, e.g. release the wrong semver-major/minor/patch, here are the steps:
21+
22+
1. Unpublish from npmjs
23+
24+
_Originated from https://www.npmjs.com/policies/unpublish_
25+
26+
Run:
27+
`npm unpublish <package_name>@<version> to remove a specific version`
28+
29+
Note: Once package@version has been used, you can never use it again. You must publish a new version even if you unpublished the old one
30+
31+
You can verify the package is unpublished by running `npm view <package_name>`.
32+
33+
2. Remove git tag
34+
35+
_Originated from https://stackoverflow.com/questions/5480258/how-to-delete-a-git-remote-tag_
36+
37+
After you've released, a new git tag is created. You can find that out from the repo page > Releases, for example, https://github.com/strongloop/loopback-datasource-juggler/releases.
38+
39+
`git push --delete origin <tagname>`
40+
If you also need to delete the local tag, use:
41+
42+
`git tag --delete <tagname>`
43+
44+
3. Revert the changes in `CHANGES.md`
45+
46+
- You can check the latest changes by running `git show`.
47+
48+
- To revert, run `git revert HEAD`.
49+
50+
Note: you might want to edit the commit message stating that it was released accidentally so that maintainers/users know why we're reverting it.
51+
52+
- Push changes, `git push`.
53+

0 commit comments

Comments
 (0)