import community files from pages-themes

This commit is contained in:
Ben Balter 2018-01-31 10:48:22 -05:00
Родитель 97d82dd4eb
Коммит 4f22036693
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: DBB67C246AD356C4
10 изменённых файлов: 244 добавлений и 42 удалений

3
.github/CODEOWNERS поставляемый Normal file
Просмотреть файл

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

32
.github/CONTRIBUTING.md поставляемый
Просмотреть файл

@ -1,32 +0,0 @@
# Contributing to the GitHub Pages Gem
Hi there! We're glad you're interested in contributing to the GitHub Pages Gem. Before you do, please be sure to read the following:
## Where to get help or report an issue
See [the support guidelines](SUPPORT.md)
## Contributing
Interested in contributing? Great. We'd love you to. Before contributing be sure to read and understand [the project goals](https://github.com/github/pages-gem/blob/master/README.md#project-goals).
## How to contribute
1. Fork the project
2. Create a new, descriptively named branch
3. Commit your proposed changes
4. Submit a pull request
## Testing with Bundler
To test your Gem with [Bundler](http://bundler.io), you can:
1. Create a directory
2. Add a `Gemfile` like the following:
```ruby
gem 'github-pages', :git => 'https://github.com/<you>/pages-gem.git', :branch => '<your branch name>', :require => 'gh-pages'
```
3. Execute `bundle install`
4. Test

11
.github/ISSUE_TEMPLATE.md поставляемый
Просмотреть файл

@ -1,21 +1,14 @@
### Before submitting an issue, please be sure to
- [ ] Read [the contributing instructions](https://github.com/github/pages-gem/blob/master/.github/CONTRIBUTING.md#contributing-to-the-github-pages-gem)
- [ ] Read [the contributing instructions](https://github.com/github/pages-gem/blob/master/docs/CONTRIBUTING.md#contributing-to-the-github-pages-gem)
- [ ] Update to the latest Gem version (run `bundle update github-pages`)
## Before suggesting a Jekyll plugin, please make sure the plugin is
- [ ] useful for a vast majority of users
- [ ] available as a gem
- [ ] covered with a test suite
- [ ] actively maintained
### This issue affects
- [ ] The site generated by GitHub Pages
- [ ] Building sites locally
*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).*
*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).*
### What did you do (e.g., steps to reproduce)

20
.github/config.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,20 @@
# Behaviorbot config. See https://github.com/behaviorbot/ for more information.
# Note: Please Don't edit this file directly.
# Edit https://github.com/pages-themes/maintenance-scripts instead.
# Configuration for update-docs - https://github.com/behaviorbot/update-docs
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:"
# Configuration for request-info - https://github.com/behaviorbot/request-info
requestInfoReplyComment: Thanks for this. Do you mind providing a bit more information about what problem you're trying to solve?
requestInfoLabelToAdd: more-information-needed
# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome
#newIssueWelcomeComment: >
# Welcome!
# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome
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).
# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge
firstPRMergeComment: "Congrats on getting your first pull request to The GitHub Pages Gem merged! Without amazing humans like you submitting pull requests, we couldnt 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)."

13
.github/no-response.yml поставляемый Normal file
Просмотреть файл

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

31
.github/settings.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,31 @@
# Repository settings set via https://github.com/probot/settings
repository:
has_issues: true
has_wiki: false
has_projects: false
has_downloads: false
labels:
- name: help wanted
oldname: help-wanted
color: 0e8a16
- name: more-information-needed
color: d93f0b
- name: bug
color: b60205
- name: feature
color: 1d76db
- name: good first issue
color: "5319e7"
# Not currently implemented by probot/settings, but manually implemented in script/deploy
branch_protection:
restrictions: null
enforce_admins: false
required_status_checks:
strict: true
contexts:
- "continuous-integration/travis-ci"
required_pull_request_reviews:
require_code_owner_reviews: true

27
.github/stale.yml поставляемый Normal file
Просмотреть файл

@ -0,0 +1,27 @@
# Configuration for probot-stale - https://github.com/probot/stale
# Number of days of inactivity before an Issue or Pull Request becomes stale
daysUntilStale: 60
# Number of days of inactivity before a stale Issue or Pull Request is closed
daysUntilClose: 7
# Issues or Pull Requests with these labels will never be considered stale
exemptLabels:
- pinned
- security
# Label to use when marking as stale
staleLabel: wontfix
# Comment to post when marking as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale Issue or Pull Request. Set to `false` to disable
closeComment: false
# Limit to only `issues` or `pulls`
# only: issues

46
docs/CODE_OF_CONDUCT.md Normal file
Просмотреть файл

@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct
## Our Pledge
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.
## Our Standards
Examples of behavior that contributes to creating a positive environment include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting
## Our Responsibilities
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.
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.
## Scope
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.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at opensource@github.com. 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.
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.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

101
docs/CONTRIBUTING.md Normal file
Просмотреть файл

@ -0,0 +1,101 @@
# Contributing to The GitHub Pages Gem
Hi there! We're thrilled that you'd like to contribute to The GitHub Pages Gem. Your help is essential for keeping it great.
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.
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.
## Looking for support?
We'd love to help. Check out [the support guidelines](SUPPORT.md).
## How to report a bug
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).
Here are a few tips for writing *great* bug reports:
* Complete the template provided on the new issue form
* Describe the specific problem (e.g., "widget doesn't turn clockwise" versus "getting an error")
* Include the steps to reproduce the bug, what you expected to happen, and what happened instead
* Check that you are using the latest version of the project and its dependencies
* Include what version of the project your using, as well as any relevant dependencies
* Only include one bug per issue. If you have discovered two bugs, please file two issues
* Even if you don't know how to fix the bug, including a failing test may help others track it down
**If you find a security vulnerability, do not open an issue. Please email security@github.com instead.**
## How to suggest a feature or enhancement
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).
Generally, requests for additional plugins are only considered if:
* The plugin is useful for a vast majority of users
* The plugin is available as a gem
* The plugin is covered with an extensive test suite
* The plugin is actively maintained
## Your first contribution
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:
* [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
* [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
*p.s. Feel free to ask for help; everyone is a beginner at first* :smiley_cat:
## How to propose changes
Here's a few general guidelines for proposing changes:
* If you are changing any user-facing functionality, please be sure to update the documentation
* 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
* Do not commit changes to files that are irrelevant to your feature or bug fix
* Don't bump the version number in your pull request (it will be bumped prior to release)
* Write [a good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html)
At a high level, [the process for proposing changes](https://guides.github.com/introduction/flow/) is:
1. [Fork](https://github.com/github/pages-gem/fork) and clone the project
2. Configure and install the dependencies: `script/bootstrap`
3. Make sure the tests pass on your machine: `script/cibuild`
4. Create a new branch: `git checkout -b my-branch-name`
5. Make your change, add tests, and make sure the tests still pass
6. Push to your fork and [submit a pull request](https://github.com/github/pages-gem/compare)
7. Pat your self on the back and wait for your pull request to be reviewed and merged
**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)
## Bootstrapping your local development environment
`script/bootstrap`
## Running tests
`script/cibuild`
## Testing with Bundler
To test your Gem with [Bundler](http://bundler.io), you can:
1. Create a directory
2. Add a `Gemfile` like the following:
```ruby
gem 'github-pages', :git => 'https://github.com/<you>/pages-gem.git', :branch => '<your branch name>', :require => 'gh-pages'
```
3. Execute `bundle install`
4. Test
## Code of conduct
This project is governed by [the Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
## Additional Resources
* [Contributing to Open Source on GitHub](https://guides.github.com/activities/contributing-to-open-source/)
* [Using Pull Requests](https://help.github.com/articles/using-pull-requests/)
* [GitHub Help](https://help.github.com)

Просмотреть файл

@ -6,7 +6,7 @@
* 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).
* 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).
* 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).
### Questions