Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: Include clarification for configuration #151

Merged
merged 2 commits into from
Oct 16, 2017
Merged

fix: Include clarification for configuration #151

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
29c2e6f
fix: Include clarification for configuration
Techforchange Oct 14, 2017
f552f8f
Include configured example in read me file
Techforchange Oct 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 10 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,25 @@ First-timers-bot is built with [Probot](https://probot.github.io/).

### Configuration

The first-timers app works without configuration. If you want to change the default settings, create a .github/first-timers.yml file with the content below and then you can adjust the options to your preference.
The first-timers app works without configuration. If you want to change the default settings, create a .github/first-timers.yml file with the content below and then you can adjust the options to your preference. When both the template & the repository is set, then the template is loaded from the _configured_ repository at the configured template path.
Copy link
Contributor

@gr2m gr2m Oct 14, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great :)

I wonder if we could link to Hoodie’s setup as an example? E.g. hoodiehq/first-timers-bot repository’s .github/first-timers.yml file is using hoodiehq/camp repository’s .github/FIRST_TIMERS_ISSUE_TEMPLATE.md file as template to create an issue like this one: hoodiehq/camp#126


```yaml
# You can create the issue in a different repo than where the problem is. Just make sure you installed the bot on the configured repository.
# The issue will link back to the original repository where the contribution will be made.
repository: repo-name

# you can change the labels to suit your needs if "first-timers-only" is not what you are looking for.
# You can change the labels to suit your needs if "first-timers-only" is not what you are looking for.
# These are some examples.
labels:
- first-timers-only
- hacktoberfest

#If you would like to add your own template for the issue, add an .md file to your .github folder
template: .github/first-timers-issue-template.md
template: .github/first-timers-issue-template.md

# You can create the issue in a different repo than where the problem is. Just make sure you installed the bot on the configured repository.
# The issue will link back to the original repository where the contribution will be made.
repository: repo-name
```
**Configuration Example** 🖥 💯

Our `hoodiehq/first-timers-bot` repository’s [`.github/first-timers.yml`](https://github.com/hoodiehq/first-timers-bot/blob/master/.github/first-timers.yml) file is using `hoodiehq/camp` repository’s [`.github/FIRST_TIMERS_ISSUE_TEMPLATE.md`](https://github.com/hoodiehq/hoodie/blob/master/.github/first-timers.yml) file as a template to create an issue such as this one: https://github.com/hoodiehq/camp/issues/126.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nice!!


### 👩‍💻💕About Us
<!-- Contributors START
Expand Down