Skip to content

Commit 78a21d2

Browse files
committed
remove outdated info
1 parent 6f161ef commit 78a21d2

File tree

4 files changed

+29
-37
lines changed

4 files changed

+29
-37
lines changed

CONTRIBUTING.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,34 @@ Bug reports and pull requests from users are what keep this project working.
1111
5. Publish the branch (`git push origin my-new-feature`)
1212
6. Create a new Pull Request
1313

14+
## Running for development
15+
16+
Make sure you have `ruby`, `gem` and `bundle` installed locally.
17+
18+
If you don't: `gem install bundler`
19+
20+
#### Step 1: Install requirements
21+
22+
```
23+
bundle install
24+
```
25+
26+
#### Step 2: Install linters: overcommit, rubocop
27+
28+
```
29+
overcommit --install
30+
```
31+
32+
#### Step 3: Run & debug
33+
34+
TBD
35+
36+
#### Step 4: Test it
37+
38+
```
39+
bundle exec rake
40+
```
41+
1442
## Checking your work
1543

1644
You can test your workflow with changelog generator with

README.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,6 @@
55

66
# github-changelog-generator ![GitHub Logo](../master/images/logo.jpg)
77

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-
---
138
<!--
149
To update TOC, please run:
1510
> doctoc ./README.md --github
@@ -289,27 +284,6 @@ I'm not trying to compare the quality of handwritten and auto-generated logs. Th
289284

290285
An auto-generated changelog really helps, even if you manually fill in the release notes!
291286

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`
313287

314288
- ***My Ruby version is very old, can I use this?***
315289

@@ -349,7 +323,7 @@ We have collected notes on how to contribute to this project in [CONTRIBUTING.md
349323
[CONTRIBUTING.md]: CONTRIBUTING.md
350324

351325
## 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)
353327

354328
## License
355329

bin/git-generate-changelog

Lines changed: 0 additions & 5 deletions
This file was deleted.

bin/github_changelog_generator

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)