Skip to content

Commit 4f22036

Browse files
committed
import community files from pages-themes
1 parent 97d82dd commit 4f22036

10 files changed

+244
-42
lines changed

.github/CODEOWNERS

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Require maintainer's :+1: for changes to the .github/ repo-config files
2+
# mainly due to https://github.com/probot/settings privilege escalation
3+
.github/* @github/pages

.github/CONTRIBUTING.md

-32
This file was deleted.

.github/ISSUE_TEMPLATE.md

+2-9
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,14 @@
11
### Before submitting an issue, please be sure to
22

3-
- [ ] Read [the contributing instructions](https://github.com/github/pages-gem/blob/master/.github/CONTRIBUTING.md#contributing-to-the-github-pages-gem)
3+
- [ ] Read [the contributing instructions](https://github.com/github/pages-gem/blob/master/docs/CONTRIBUTING.md#contributing-to-the-github-pages-gem)
44
- [ ] Update to the latest Gem version (run `bundle update github-pages`)
55

6-
## Before suggesting a Jekyll plugin, please make sure the plugin is
7-
8-
- [ ] useful for a vast majority of users
9-
- [ ] available as a gem
10-
- [ ] covered with a test suite
11-
- [ ] actively maintained
12-
136
### This issue affects
147

158
- [ ] The site generated by GitHub Pages
169
- [ ] Building sites locally
1710

18-
*The GitHub Pages Gem is intended to help users replicate the GitHub Pages build environment locally. If your issue affects both the hosted version and the version previewed locally, you may be better suited reporting [seeking support in other forums](https://github.com/github/pages-gem/blob/master/.github/CONTRIBUTING.md#where-to-get-help-or-report-an-issue).*
11+
*The GitHub Pages Gem is intended to help users replicate the GitHub Pages build environment locally. If your issue affects both the hosted version and the version previewed locally, you may be better suited reporting [seeking support in other forums](https://github.com/github/pages-gem/blob/master/docs/SUPPORT.md).*
1912

2013
### What did you do (e.g., steps to reproduce)
2114

.github/config.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
2+
# Note: Please Don't edit this file directly.
3+
# Edit https://github.com/pages-themes/maintenance-scripts instead.
4+
5+
# Configuration for update-docs - https://github.com/behaviorbot/update-docs
6+
updateDocsComment: "Thanks for the pull request! If you are making any changes to the user-facing functionality, please be sure to update the documentation in the `README` or `docs/` folder alongside your change. :heart:"
7+
8+
# Configuration for request-info - https://github.com/behaviorbot/request-info
9+
requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
10+
requestInfoLabelToAdd: more-information-needed
11+
12+
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
13+
#newIssueWelcomeComment: >
14+
# Welcome!
15+
16+
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
17+
newPRWelcomeComment: Welcome! Congrats on your first pull request to The GitHub Pages Gem. If you haven't already, please be sure to check out [the contributing guidelines](https://github.com/github/pages-gem/blob/master/docs/CONTRIBUTING.md).
18+
19+
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
20+
firstPRMergeComment: "Congrats on getting your first pull request to The GitHub Pages Gem merged! Without amazing humans like you submitting pull requests, we couldn’t run this project. You rock! :tada:<br /><br />If you're interested in tackling another bug or feature, take a look at [the open issues](https://github.com/github/pages-gem/issues), especially those [labeled `help wanted`](https://github.com/github/pages-gem/issues?q=is%3Aopen+is%3Aissue+label%3A%22help+wanted%22)."

.github/no-response.yml

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Configuration for probot-no-response - https://github.com/probot/no-response
2+
3+
# Number of days of inactivity before an Issue is closed for lack of response
4+
daysUntilClose: 14
5+
# Label requiring a response
6+
responseRequiredLabel: more-information-needed
7+
# Comment to post when closing an Issue for lack of response. Set to `false` to disable
8+
closeComment: >
9+
This issue has been automatically closed because there has been no response
10+
to our request for more information from the original author. With only the
11+
information that is currently in the issue, we don't have enough information
12+
to take action. Please reach out if you have or find the answers we need so
13+
that we can investigate further.

.github/settings.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Repository settings set via https://github.com/probot/settings
2+
3+
repository:
4+
has_issues: true
5+
has_wiki: false
6+
has_projects: false
7+
has_downloads: false
8+
9+
labels:
10+
- name: help wanted
11+
oldname: help-wanted
12+
color: 0e8a16
13+
- name: more-information-needed
14+
color: d93f0b
15+
- name: bug
16+
color: b60205
17+
- name: feature
18+
color: 1d76db
19+
- name: good first issue
20+
color: "5319e7"
21+
22+
# Not currently implemented by probot/settings, but manually implemented in script/deploy
23+
branch_protection:
24+
restrictions: null
25+
enforce_admins: false
26+
required_status_checks:
27+
strict: true
28+
contexts:
29+
- "continuous-integration/travis-ci"
30+
required_pull_request_reviews:
31+
require_code_owner_reviews: true

.github/stale.yml

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 60
5+
6+
# Number of days of inactivity before a stale Issue or Pull Request is closed
7+
daysUntilClose: 7
8+
9+
# Issues or Pull Requests with these labels will never be considered stale
10+
exemptLabels:
11+
- pinned
12+
- security
13+
14+
# Label to use when marking as stale
15+
staleLabel: wontfix
16+
17+
# Comment to post when marking as stale. Set to `false` to disable
18+
markComment: >
19+
This issue has been automatically marked as stale because it has not had
20+
recent activity. It will be closed if no further activity occurs. Thank you
21+
for your contributions.
22+
23+
# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
24+
closeComment: false
25+
26+
# Limit to only `issues` or `pulls`
27+
# only: issues

docs/CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

docs/CONTRIBUTING.md

+101
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
# Contributing to The GitHub Pages Gem
2+
3+
Hi there! We're thrilled that you'd like to contribute to The GitHub Pages Gem. Your help is essential for keeping it great.
4+
5+
The GitHub Pages Gem is an open source project supported by the efforts of an entire community and built one contribution at a time by users like you. We'd love for you to get involved. Whatever your level of skill or however much time you can give, your contribution is greatly appreciated. There are many ways to contribute, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, helping other users by commenting on issues, or writing code which can be incorporated into The GitHub Pages Gem itself.
6+
7+
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
8+
9+
## Looking for support?
10+
11+
We'd love to help. Check out [the support guidelines](SUPPORT.md).
12+
13+
## How to report a bug
14+
15+
Think you found a bug? Please check [the list of open issues](https://github.com/github/pages-gem/issues) to see if your bug has already been reported. If it hasn't please [submit a new issue](https://github.com/github/pages-gem/issues/new).
16+
17+
Here are a few tips for writing *great* bug reports:
18+
19+
* Complete the template provided on the new issue form
20+
* Describe the specific problem (e.g., "widget doesn't turn clockwise" versus "getting an error")
21+
* Include the steps to reproduce the bug, what you expected to happen, and what happened instead
22+
* Check that you are using the latest version of the project and its dependencies
23+
* Include what version of the project your using, as well as any relevant dependencies
24+
* Only include one bug per issue. If you have discovered two bugs, please file two issues
25+
* Even if you don't know how to fix the bug, including a failing test may help others track it down
26+
27+
**If you find a security vulnerability, do not open an issue. Please email [email protected] instead.**
28+
29+
## How to suggest a feature or enhancement
30+
31+
General GitHub Pages feature requests, including requests to add additional plugins or themes should be made via [GitHub Support](https://github.com/contact?form%5Bsubject%5D=GitHub%20Pages%20Feature%20Request).
32+
33+
Generally, requests for additional plugins are only considered if:
34+
35+
* The plugin is useful for a vast majority of users
36+
* The plugin is available as a gem
37+
* The plugin is covered with an extensive test suite
38+
* The plugin is actively maintained
39+
40+
## Your first contribution
41+
42+
We'd love for you to contribute to the project. Unsure where to begin contributing to The GitHub Pages Gem? You can start by looking through these "good first issue" and "help wanted" issues:
43+
44+
* [Good first issues](https://github.com/github/pages-gem/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) - issues which should only require a few lines of code and a test or two
45+
* [Help wanted issues](https://github.com/github/pages-gem/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) - issues which may be a bit more involved, but are specifically seeking community contributions
46+
47+
*p.s. Feel free to ask for help; everyone is a beginner at first* :smiley_cat:
48+
49+
## How to propose changes
50+
51+
Here's a few general guidelines for proposing changes:
52+
53+
* If you are changing any user-facing functionality, please be sure to update the documentation
54+
* Each pull request should implement **one** feature or bug fix. If you want to add or fix more than one thing, submit more than one pull request
55+
* Do not commit changes to files that are irrelevant to your feature or bug fix
56+
* Don't bump the version number in your pull request (it will be bumped prior to release)
57+
* Write [a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
58+
59+
At a high level, [the process for proposing changes](https://guides.github.com/introduction/flow/) is:
60+
61+
1. [Fork](https://github.com/github/pages-gem/fork) and clone the project
62+
2. Configure and install the dependencies: `script/bootstrap`
63+
3. Make sure the tests pass on your machine: `script/cibuild`
64+
4. Create a new branch: `git checkout -b my-branch-name`
65+
5. Make your change, add tests, and make sure the tests still pass
66+
6. Push to your fork and [submit a pull request](https://github.com/github/pages-gem/compare)
67+
7. Pat your self on the back and wait for your pull request to be reviewed and merged
68+
69+
**Interesting in submitting your first Pull Request?** It's easy! You can learn how from this *free* series [How to Contribute to an Open Source Project on GitHub](https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github)
70+
71+
## Bootstrapping your local development environment
72+
73+
`script/bootstrap`
74+
75+
## Running tests
76+
77+
`script/cibuild`
78+
79+
## Testing with Bundler
80+
81+
To test your Gem with [Bundler](http://bundler.io), you can:
82+
83+
1. Create a directory
84+
2. Add a `Gemfile` like the following:
85+
86+
```ruby
87+
gem 'github-pages', :git => 'https://github.com/<you>/pages-gem.git', :branch => '<your branch name>', :require => 'gh-pages'
88+
```
89+
90+
3. Execute `bundle install`
91+
4. Test
92+
93+
## Code of conduct
94+
95+
This project is governed by [the Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
96+
97+
## Additional Resources
98+
99+
* [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
100+
* [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
101+
* [GitHub Help](https://help.github.com)

.github/SUPPORT.md renamed to docs/SUPPORT.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
* If your think you may have found a bug in Jekyll itself, please [open an issue in the Jekyll repository](https://github.com/jekyll/jekyll/issues/new).
88

9-
* If you think you may have found a bug with how the GitHub Pages Gem bootstraps your local development environment, please [open an issue in this repository](https://github.com/github/pages-gem/issues/new).
9+
* If you think you may have found a bug with how the GitHub Pages Gem bootstraps your local development environment, please [check the existing issues](https://github.com/github/pages-gem/issues), and if no one has reported the problem, [open a new issue](https://github.com/github/pages-gem/issues/new).
1010

1111
### Questions
1212

0 commit comments

Comments
 (0)