|
5 | 5 |
|
6 | 6 | # github-changelog-generator 
|
7 | 7 |
|
8 |
| -#### Update: |
9 |
| - |
10 |
| -🖖 Keep it alive: We need more Collaborators to github-changelog-generator [#727](https://github.com/github-changelog-generator/github-changelog-generator/issues/727) |
11 |
| - |
12 |
| ---- |
13 | 8 | <!--
|
14 | 9 | To update TOC, please run:
|
15 | 10 | > doctoc ./README.md --github
|
@@ -289,27 +284,6 @@ I'm not trying to compare the quality of handwritten and auto-generated logs. Th
|
289 | 284 |
|
290 | 285 | An auto-generated changelog really helps, even if you manually fill in the release notes!
|
291 | 286 |
|
292 |
| -For example: |
293 |
| - |
294 |
| -When you find a closed bug, it is very useful to know which release fixed it. |
295 |
| -So that you can easily find the issue by \# in `CHANGELOG.md`. |
296 |
| - |
297 |
| -- It's not quite as easy to find this in handwritten releases notes. |
298 |
| -- A generated file saves you the trouble of remembering everything; |
299 |
| - sometimes people forget to add things to a handwritten file. |
300 |
| - |
301 |
| -Ultimately, I think GitHub Releases are ideal for end-users. |
302 |
| -Meanwhile, `CHANGELOG.md` lives right in the repository, with its detailed list of changes, which is handy for developers. |
303 |
| -Finally, there's nothing wrong with using GitHub Releases alongside `CHANGELOG.md` in this combination. |
304 |
| - |
305 |
| -- ***I got an "API rate limit exceeded" error message. What does this mean?*** |
306 |
| - |
307 |
| -GitHub [limits the number of API requests](https://developer.github.com/v3/#rate-limiting) you can make in an hour. You can make up to 5,000 requests per hour. For unauthenticated requests, the rate limit is only up to 60 requests per hour. Unauthenticated requests are associated with your IP address (not the user making requests). |
308 |
| - |
309 |
| -If you're seeing this warning, please do the following: |
310 |
| - |
311 |
| -1. Make sure you're providing an OAuth token, so you're not making requests anonymously. Using an OAuth token increases your hourly request maximum from 60 to 5000. |
312 |
| -2. If you have a large repo with lots of issues/PRs, you can use `--max-issues NUM` to limit the number of issues that are pulled back. For example: `--max-issues 1000` |
313 | 287 |
|
314 | 288 | - ***My Ruby version is very old, can I use this?***
|
315 | 289 |
|
@@ -349,7 +323,7 @@ We have collected notes on how to contribute to this project in [CONTRIBUTING.md
|
349 | 323 | [CONTRIBUTING.md]: CONTRIBUTING.md
|
350 | 324 |
|
351 | 325 | ## Contact us
|
352 |
| -Feel free to ask your questions [gitter.im chat])https://gitter.im/github-changelog-generator) |
| 326 | +[Join the chat at gitter : github-changelog-generator](https://gitter.im/github-changelog-generator/chat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) |
353 | 327 |
|
354 | 328 | ## License
|
355 | 329 |
|
|
0 commit comments