https://github.com/browserify/admin
administrative procedures for the browserify org
https://github.com/browserify/admin
meta
Last synced: 10 months ago
JSON representation
administrative procedures for the browserify org
- Host: GitHub
- URL: https://github.com/browserify/admin
- Owner: browserify
- Created: 2017-08-30T19:41:39.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-09-24T19:23:15.000Z (over 6 years ago)
- Last Synced: 2025-02-16T15:33:57.066Z (12 months ago)
- Topics: meta
- Homepage:
- Size: 2.93 KB
- Stars: 12
- Watchers: 19
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# browserify administration handbook
This document is for members of the browserify org.
The sections below document administrative procedures for adding packages,
adding new users, and some tips on handling issues and pull requests.
# principles
* avoid human bottlenecks
* trust people to do the right thing (until proven otherwise)
In order to minimize human bottlenecks, all members should be fully empowered to
do everything that might be necessary to handle administration of the project.
For some actions, it might be good to discuss with other members and the
community about the best course of action. For other decisions, it might be
better to take individual initiative.
# adding new members
New members should be added liberally! If you identify someone who is interested
in contributing to core or any of the browserify satellite projects, seems
trustworthy, and agrees to the [code of conduct][], you can follow the steps
below. You should feel individually empowered to make a decision.
New members should be added as owners on github and npm.
For github:
Visit https://github.com/orgs/browserify/people and click the green "invite
member" button. Type in the github username and add the new member as an owner.
For npm:
Visit https://www.npmjs.com/settings/browserify/members and type in the npm user
name. Set the radio button to "owner" then click the red "add member" button.
[code of conduct]: https://raw.githubusercontent.com/browserify/browserify/master/code-of-conduct.md
# adding a package to the browserify org
To add a package to the browserify org, you will need to transfer ownership on
github as well as add the package to the browserify org on npm.
For github:
Visit the project page settings for a github user `$USER` and a project name
`$PROJECT` at:
https://github.com/$USER/$PROJECT/settings
At the bottom in the "danger zone" box, click "transfer ownership".
Type the name of the repository to confirm and below that box, type "browserify"
in the field labeled "new owner's github username or organization name".
For npm, run this command, replacing `$PKGNAME` with the name of the package on
npm:
```
npx npm@6.5 access grant read-write browserify:developers $PKGNAME
```
(An old version of npm is required because recent versions of npm prohibit orgs
from managing unscoped packages.)
# publishing a package
When you are ready to publish a new version of a package, here are some steps to
follow:
* update the `package.json` "version" field according to [semver][]
* make a git commit with the version number in the comment
* use (for example) `git tag 1.2.3` or `git tag v1.2.3` to tag a release
* push to github using `git push origin master --tags`
* run `npm publish`
Individual projects may have slight variations. It's best to stick to whatever
conventions they've established. You can list existing tags by typing `git tag`.
Changes to any user-facing or implementation side of the package, including
documentation fixes, should be published to npm.
It's better to have several smaller updates for each new feature or fix rather
than one big update where possible.
[semver]: http://semver.org/