-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[minor] adding pull request and issue templates, relocating CONTRIBUT…
…ING.md
- Loading branch information
Brandon Black
committed
Feb 25, 2016
1 parent
4a92f61
commit 3265f5d
Showing
4 changed files
with
119 additions
and
77 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,77 @@ | ||
# Contributing Guidelines | ||
|
||
We love pull requests from everyone! | ||
|
||
We encourage community contributions for all kinds of changes | ||
both big and small, but we ask that you adhere to the following guidelines for contributing code. | ||
|
||
##### Proposing Changes | ||
|
||
As a starting point for all changes, we recommend [reporting an issue][report-issue] | ||
before you begin making any changes. Make sure to search the issues on this repository | ||
first to check and see the issue has already been previously discussed and whether or | ||
not it's already being worked on. | ||
|
||
- For small changes, improvements and bug fixes please feel free to send us a pull | ||
request with proposed changes along-side the issue you report. | ||
|
||
- For larger more involved or design related changes, please open an issue and discuss | ||
the changes with the other contributors before submitting any pull requests. | ||
|
||
[report-issue]: https://github.com/twitterdev/twitter-ruby-ads-sdk/issues?q=is%3Aopen+is%3Aissue | ||
|
||
##### Submitting A Pull Request | ||
|
||
1) Fork us and clone the repository locally. | ||
|
||
```bash | ||
git clone [email protected]:twitterdev/twitter-ruby-ads-sdk.git | ||
``` | ||
|
||
2) Install development dependencies: | ||
|
||
```bash | ||
# install bundler (if you don't have it already) | ||
gem install bundler | ||
|
||
# install all development dependencies | ||
bundle install | ||
``` | ||
|
||
3) Make sure all tests pass before you start: | ||
|
||
```bash | ||
rake | ||
``` | ||
|
||
4) Make your changes! (Don't forget tests and documentation) | ||
|
||
5) Test your changes again and make sure everything passes: | ||
|
||
```bash | ||
rake | ||
``` | ||
|
||
The test suite will automatically enforce test coverage and code style. | ||
For the most part, we follow [this][style] community style guide with a | ||
[few exceptions](https://github.com/twitterdev/twitter-ruby-ads-sdk/blob/master/.rubocop.yml). | ||
|
||
[style]: https://github.com/bbatsov/ruby-style-guide | ||
|
||
6) Submit your changes! | ||
|
||
- [Squash](http://eli.thegreenplace.net/2014/02/19/squashing-github-pull-requests-into-a-single-commit) your development commits. Put features in a single clean commit whenever possible or logically split it into a few commits (no development commits). Test coverage can be included in a separate commit if preferred. | ||
- Write a [good commit message][commit] for your change. | ||
- Push to your fork. | ||
- Submit a [pull request][pr]. | ||
|
||
[commit]: http://chris.beams.io/posts/git-commit/ | ||
[pr]: https://github.com/thoughtbot/suspenders/compare/ | ||
|
||
We try to at least comment on pull requests within one business day and may suggest changes. | ||
|
||
##### Release Schedule and Versioning | ||
|
||
We have a regular release cadence and adhere to [semantic versioning](http://semver.org/). When | ||
exactly your change ships will depend on the scope of your changes and what type of upcoming release | ||
its best suited for. |
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,24 @@ | ||
**Issue Type:** Bug, Question, Improvement or Feature (Select One) | ||
|
||
**Description:** | ||
|
||
A brief overview of the issue. Please make sure to include detailed information and a clearly written assessment of the impact or priority of the issue. | ||
|
||
**Expected Result:** | ||
```ruby | ||
# expected output here | ||
``` | ||
|
||
**Actual Result:** | ||
```ruby | ||
# actual output here | ||
``` | ||
|
||
**Steps to Reproduce:** | ||
|
||
- | ||
- | ||
- | ||
|
||
|
||
**Relates To:** #123 |
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,17 @@ | ||
**Issue Type:** Bug, Improvement or Feature (Select One) | ||
|
||
**Fixes / Relates To:** #123 | ||
|
||
**Changes Included:** | ||
|
||
- | ||
- | ||
- | ||
|
||
**Check List:** | ||
|
||
- [ ] Includes adequate test [coverage](https://github.com/twitterdev/twitter-ruby-ads-sdk/tree/master/spec) for changes made. | ||
- [ ] Includes new or updated [documentation](http://twitterdev.github.io/twitter-ruby-ads-sdk/reference/index.html). | ||
- [ ] Includes new or updated usage [examples](https://github.com/twitterdev/twitter-ruby-ads-sdk/tree/master/examples). | ||
|
||
_For more information on check list items, please see the [Contributors Guide](https://github.com/twitterdev/twitter-ruby-ads-sdk/tree/master/CONTRIBUTING.md)._ |
This file was deleted.
Oops, something went wrong.
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 @@ | ||
.github/CONTRIBUTING.md |