chiu
/
google-auth-library-ruby
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Adds a CHANGELOG.md 

- also update CONTRIBUTING.md with more detail
This commit is contained in:
Tim Emiola 2015-03-23 15:49:18 -07:00
parent 395febd0f0
commit 86435f1913
2 changed files with 59 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
CHANGELOG.md Normal file
View File

@ -0,0 +1,8 @@
## 0.3.0 (23/03/2015)
### Changes
* makes the scope parameter's optional in all APIs. ([@tbetbetbe][])
* changes the scope parameter's position in various constructors. ([@tbetbetbe][])
[@tbetbetbe]: https://github.com/tbetbetbe

61
CONTRIBUTING.md
View File

@ -2,7 +2,7 @@
## Contributor License Agreements ## Contributor License Agreements
We'd love to accept your sample apps and patches! Before we can take them, we We'd love to accept your sample apps and patches! Before we can take them, we
have to jump a couple of legal hurdles. have to jump a couple of legal hurdles.
Please fill out either the individual or corporate Contributor License Agreement Please fill out either the individual or corporate Contributor License Agreement
@ -19,14 +19,55 @@ Follow either of the two links above to access the appropriate CLA and
instructions for how to sign and return it. Once we receive it, we'll be able to instructions for how to sign and return it. Once we receive it, we'll be able to
accept your pull requests. accept your pull requests.
## Contributing A Patch ## Issue reporting
1. Submit an issue describing your proposed change to the repo in question. * Check that the issue has not already been reported.
1. The repo owner will respond to your issue promptly. * Check that the issue has not already been fixed in the latest code
1. If your proposed change is accepted, and you haven't already done so, sign a (a.k.a. `master`).
Contributor License Agreement (see details above). * Be clear, concise and precise in your description of the problem.
1. Fork the desired repo, develop and test your code changes. * Open an issue with a descriptive title and a summary in grammatically correct,
1. Ensure that your code is clear and comprehensible. complete sentences.
1. Ensure that your code has an appropriate set of unit tests which all pass. * Include any relevant code to the issue summary.
1. Submit a pull request.
## Pull requests
* Read [how to properly contribute to open source projects on Github][2].
* Fork the project.
* Use a topic/feature branch to easily amend a pull request later, if necessary.
* Write [good commit messages][3].
* Use the same coding conventions as the rest of the project.
* Commit and push until you are happy with your contribution.
* Make sure to add tests for it. This is important so I don't break it
in a future version unintentionally.
* Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
* Please try not to mess with the Rakefile, version, or history. If you want to
have your own version, or is otherwise necessary, that is fine, but please
isolate to its own commit so I can cherry-pick around it.
* Make sure the test suite is passing and the code you wrote doesn't produce
RuboCop offenses.
* [Squash related commits together][5].
* Open a [pull request][4] that relates to *only* one subject with a clear title
and description in grammatically correct, complete sentences.
### Changelog entry format
Here are a few examples:
```
* makes the scope parameter's optional in all APIs. (@tbetbetbe[])
* [#14](https://github.com/google/google-auth-library-ruby/issues/14): ADC Support for JWT Service Tokens. ([@tbetbetbe][])
```
* Mark it up in [Markdown syntax][6].
* The entry line should start with `* ` (an asterisk and a space).
* If the change has a related GitHub issue (e.g. a bug fix for a reported issue), put a link to the issue as `[#123](https://github.com/google/google-auth-library-ruby/issues/11): `.
* Describe the brief of the change. The sentence should end with a punctuation.
* At the end of the entry, add an implicit link to your GitHub user page as `([@username][])`.
* If this is your first contribution to google-auth-library-ruby project, add a link definition for the implicit link to the bottom of the changelog as `[@username]: https://github.com/username`.
[1]: https://github.com/google/google-auth-ruby-library/issues
[2]: http://gun.io/blog/how-to-github-fork-branch-and-pull-request
[3]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
[4]: https://help.github.com/articles/using-pull-requests
[5]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
[6]: http://daringfireball.net/projects/markdown/syntax