Skip to content

Commit

Permalink
Update the contributing guidelines
Browse files Browse the repository at this point in the history
- Tighten up conventions and add a bit more detailed information to
  guidelines
- Change any references to the `dev` branch to `devel` to match new
  convention
- Update the change log
  • Loading branch information
kahmali committed May 25, 2015
1 parent ab6defb commit d74cd16
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 12 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@
#### Fixed
- Issue #68:
- Make Restivus a server-only package (`Restivus` is now `undefined` on the client)

#### Changed
- Improve the Contributing Guidelines
- Tighten up some conventions
- Add more detailed information


## [v0.6.5] - 2015-04-27

Expand Down
45 changes: 33 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,61 @@
# Contributing to Restivus
# Contributing Guidelines

If you're thinking about making a contribution to this project, then you're in the right place.
First, thank you for taking the time to contribute! Please give everything below a read before
attempting to contribute, as it may save you some time and energy when it comes time to submit
your awesome new feature, fix, or bug report!

The following contributions to Restivus are greatly appreciated:
- Code (via pull requests of any variety)
- Code (via pull request)
- New or updated features
- Bug fixes
- README updates
- Automated tests
- Documentation updates (currently via README)
- Bug reports (via GitHub Issues)
- Feature requests and voting (via GitHub Issues)

[GitHub Issues](https://github.com/kahmali/meteor-restivus/issues) are used for all bug and feature
tracking. [Milestones](https://github.com/kahmali/meteor-restivus/milestones) will be created for
each release version (e.g., `v1.0.0`), and any associated Issues or [Pull Requests]
(https://github.com/kahmali/meteor-restivus/pulls?q=is%3Aopen+is%3Apr) will be added to the
corresponding milestone.


## Code Contributions

Contributing code to an open source project can be fun and rewarding, especially when it's done
right. Check out the guidelines below for more information on getting your changes merged into a
release.

### Coding Conventions

Please adhere to the [Meteor Style Guide](https://github.com/meteor/meteor/wiki/Meteor-Style-Guide)
for all conventions not specified here:

1. 100 character line limit for all code, comments, and documentation files


### Pull Requests

All code contributions can be submitted via GitHub Pull Requests. Here are a few guidelines you
must adhere to when contributing to this project:

1. **All pull requests should be made to the `dev` branch!** Since `dev` is not the default branch,
you'll need to be sure to change it when making the pull request. If you're not familiar with
[forks](https://help.github.com/articles/fork-a-repo/) and [pull requests]
(https://help.github.com/articles/using-pull-requests/), please check out those resources for
more information.
1. Begin your feature branches from the latest version of `dev`.
1. **All pull requests should be made on the `devel` branch, unless intended for a specific release!
In that case, they can be made on the branch matching the release version number (e.g.,
`1.0.0`)** If you're not familiar with [forks](https://help.github.com/articles/fork-a-repo/) and
[pull requests](https://help.github.com/articles/using-pull-requests/), please check out those
resources for more information.
1. Begin your feature branches from the latest version of `devel`.
1. Before submitting a pull request:
- Rebase to the latest version of `dev`
- Ensure all automated tests are passing by running `meteor test-packages ./` from the root
1. Rebase to the latest version of `devel`
1. Add automated tests to the `/tests` directory for any new features
1. Ensure all automated tests are passing by running `meteor test-packages ./` from the root
directory of the project and viewing the Tinytest output at `http://localhost:3000`
1. Update the [README](https://github.com/kahmali/meteor-restivus/blob/devel/README.md) and
[change log](https://github.com/kahmali/meteor-restivus/blob/devel/CHANGELOG.md) with any
corresponding changes
- Please follow the existing conventions within each document until detailed conventions can
be formalized for each

### Committing

Expand All @@ -52,7 +72,8 @@ together.
Please follow these guidelines for commit messages:

1. Separate subject from body with a blank line
1. Limit the subject line to 50 characters
1. Limit the subject line to 72 characters (shoot for 50 to keep things concise, but use 72 as the
hard limit)
1. Capitalize the subject line
1. Do not end the subject line with a period
1. Use the imperative mood in the subject line
Expand Down

0 comments on commit d74cd16

Please sign in to comment.