forked from barrel/barrel-cli
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9086fff
commit 9b21a32
Showing
1 changed file
with
23 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# How To Contribute | ||
|
||
## Submit an Issue | ||
|
||
If you are not sure how to get started with contributing, or have an issue, start by opening an [Issue](https://github.com/barrel/barrel-cli/issues). | ||
|
||
Provide enough details that will help the issue get visibility. | ||
|
||
- **What is the main issue?** | ||
- **How will this help the project?** | ||
- **How did you run into and replicate the issue?** | ||
- **What systems did you run the application?** | ||
|
||
## Submit a Merge Request | ||
|
||
Feel free to fork the repo and submit merge requests for existing issues and reference the issue in the Merge Request message. A reviewer will respond to the merge request with any requirements. | ||
|
||
## Publishing | ||
|
||
We use `npm` to maintain this package. The general steps to publish will only work for users added directly to our organization. | ||
|
||
1. After the merge is successful from a given feature, bump the versions with `npm version $INC` | ||
2. Publish the new version to npm with `npm publish` (pre-req `npm login`) |