-
Notifications
You must be signed in to change notification settings - Fork 6
Home
Fork the repo to your own Github account, make your changes there, and send a pull request.
The project is curated by Milestones. Each milestone has a set of issues associated with it. Each issue created, whether it be for a bug, enhancement, or new feature will be assigned to a milestone. Patch versions may have a separate milestone for them.
Example: If you are working on an issue assigned to the 1.2.0 milestone, and the current app version is 1.1.5, your pull request must have it's version as 1.1.6 in the package.json. When every issue in a milestone is completed the project's version will be upgraded to 1.2.0.
Anyone can approve a pull request. It is suggested that you get someone else to approve your own pull requests, but if nobody obliges after 24 hours, feel free to approve it yourself.
Pull Requests to Master must be approved by another person. If your pull request is to a development branch, you can approve it without waiting for a second look.
Just review the contribution, checking for obvious errors or room for improvement. If it seems fine, approve it!
The most current milestone should have a branch. If it doesn't, check with Ian to make sure it is created correctly. Fork this branch or master, but merge all changes back into this branch via pull requests.
Example: The 1.2.0 milestone should have a branch named 1.2.0. This is the branch you make your pull request to.
Feel freel to create milestones for groups of features. Group features together in ways that make sense. You can move stuff around if you are working on a couple of tickets and want to include or exclude certain features in a release.
When you fix an issue, increment a patch version (0.0.x)
When a milestone is complete, increment a minor version (0.x.0)
A major version (x.0.0) is incremented when a significant portion of the actual generator is rewritten, not just the app/ directory. If it is agreed upon by the developers that enough has changed to merit a major version, it can be incremented.
To publish to NPM, check out the repo from the BarkleyREI account, CD to the directory in terminal (or other program), and do "npm publish".
Make sure that the version number in package.json has been incremented.
To tag a release in Git, check out the repo from the BarkleyREI account, CD to the directory in terminal, and do the following commands:
git tag -a '1.1.0' -m 'Release 1.1.0'
git push origin --tags