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

Clarify requirements for packages being added to the set #288

Merged
merged 3 commits into from
Apr 6, 2019
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,15 @@ It defines some policies that are applied, and details how to add new packages a

All changes go through pull requests.

There are some criteria that packages being added should comply with:
- _You should use `pulp version` to version your package._
The reason is that the tag should start with the `v` prefix
- _You should use `pulp publish` to publish your package._
The reason is that since there are two distribution methods for packages (the Bower registry and the package sets), we rely on the Bower registry to act as a "central registry of package names" for both methods, in order to prevent divergence in the ecosystem (e.g. having two different codebases for a package called "prelude")
- `bower i -p` should run successfully
All packages that are included here must first be published via `bower` with no exceptions. Since there are two distribution methods for packages (the Bower registry and the package sets), we rely on the Bower registry to act as a "central registry of package names" for both methods. This prevents divergence in the ecosystem - e.g. having two different codebases for a package called "prelude".

Packages must comply with the following criteria. The `pulp` commands listed below are used because they handle most of the work for you:
- `bower i -p` must run successfully.
This command installs your dependencies and excludes any 'devDependencies'.
- _You must use `pulp version` to version your package._
This guarantees that the tag will start with the `v` prefix.
- _You must use `pulp publish` to publish your package._
This command will handle all of the publishing work for you.

## Releases

Expand Down