Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/jpescador/hugo-future-imperfect.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPatrick Collins <thepatrickcollins@gmail.com>2017-10-25 01:32:52 +0300
committerGitHub <noreply@github.com>2017-10-25 01:32:52 +0300
commitb93f40bb1a20521e2c238830262e33a9d740abd9 (patch)
tree59e9ac5b015658386b17595777b6cc196f3e60b2
parent54c405a15f99814200ca435c19f5af4eb216c3cb (diff)
Update docs (#70)
* Update documentation and templates * Update CODE_OF_CONDUCT.md * Fix links in CONTRIBUTING.md
-rw-r--r--.github/CODE_OF_CONDUCT.md73
-rw-r--r--.github/CONTRIBUTING.md248
-rw-r--r--.github/ISSUE_TEMPLATE.md47
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md45
-rw-r--r--images/screenshot.pngbin307330 -> 393195 bytes
-rw-r--r--images/tn.pngbin0 -> 272711 bytes
6 files changed, 399 insertions, 14 deletions
diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md
new file mode 100644
index 0000000..37b7b6e
--- /dev/null
+++ b/.github/CODE_OF_CONDUCT.md
@@ -0,0 +1,73 @@
+# 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. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and 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 https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
new file mode 100644
index 0000000..d97d104
--- /dev/null
+++ b/.github/CONTRIBUTING.md
@@ -0,0 +1,248 @@
+# Contributing Guidelines
+
+First of all, thank you from all of the [contributors] for enjoying the theme
+enough to want to give back. We have plenty of space for everyone to contribute.
+Please check for any [issues] you may be able to solve, any [pull requests] you
+can help review, any [projects] you can contribute to, or anything else you may
+see.
+
+The goal of this repository is to provide a great Hugo theme for everyone, as
+well as being an opportunity for people to learn how to use Git and GitHub.
+
+## Table of Contents
+
+
+<!-- TOC depthFrom:2 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
+
+- [Table of Contents](#table-of-contents)
+- [Getting Set Up](#getting-set-up)
+ - [Requirements](#requirements)
+ - [Forking](#forking)
+ - [Syncing](#syncing)
+ - [Git Bash, Command Prompt, PowerShell](#git-bash-command-prompt-powershell)
+ - [GitHub Desktop](#github-desktop)
+- [Creating an Issue Ticket](#creating-an-issue-ticket)
+- [Creating a Pull Request](#creating-a-pull-request)
+- [Style Guide](#style-guide)
+- [Thank You](#thank-you)
+
+<!-- /TOC -->
+
+## Getting Set Up
+
+### Requirements
+
+1. A [GitHub Account].
+2. Either [Git] (preferable) or [GitHub Desktop]
+3. The latest version of [Hugo][Hugo Release].
+4. The latest version of [hugo-future-imperfect][Head].
+
+### Forking
+
+Navigate to the theme repository [jpescador/hugo-future-imperfect][head],
+and then click **Fork** in the top right. This will create your copy of the
+theme.
+
+### Syncing
+
+Since changes to one aspect of a Hugo theme tend to require changes in multiple
+locations, this step is vital. Please *always* make sure you stay in sync with
+the original, or create an issue or pull request so we know what files are being
+worked on and we can manage it that way.
+
+#### Git Bash, Command Prompt, PowerShell
+
+*Note:* Substitute all `CAPS` with the applicable information pertaining to you.
+
+1. **Set Up Git**
+
+ If you haven't yet, you should first [set up Git][GitHub Git]. You will also
+ need to [set up authentication to GitHub from Git][GitHub Authentication] as
+ well.
+
+2. **Create A Local Copy**
+
+ ```
+ cd PATH/TO/YOUR/LOCATION
+ git clone https://github.com/YOUR-USERNAME/hugo-future-imperfect
+ ```
+
+ You have now cloned your fork to the location specified.
+
+3. **Connecting Fork with Original**
+
+ ```
+ git remote add upstream https://github.com/jpescador/hugo-future-imperfect.git
+ ````
+
+ You have now connected your fork with `jpescador/hugo-future-imperfect`,
+ the `upstream`.
+
+ To confirm this:
+
+ ```
+ git remote -v
+ ````
+
+ Which should return:
+
+ ```
+ origin https://github.com/YOUR_USERNAME/hugo-future-imperfect.git (fetch)
+ origin https://github.com/YOUR_USERNAME/hugo-future-imperfect.git (push)
+ upstream https://github.com/jpescador/hugo-future-imperfect.git (fetch)
+ upstream https://github.com/jpescador/hugo-future-imperfect.git (push)
+ ```
+
+4. **Keeping it synced**
+
+ ```
+ git fetch upstream
+ git checkout master
+ ```
+
+ You have now fetched the files from the upstream and have confirmed that you
+ are on the master branch.
+
+ 1. If you need to *merge* any changes you've made with the updated original,
+ use the following:
+
+ ```
+ git merge upstream/master
+ git push origin master
+ ```
+
+ 2. If you need to *reset* any changes you've made back to the original for
+ whatever reason, use the following:
+
+ ```
+ git reset --hard upstream/master
+ git push origin master --force
+ ```
+
+#### GitHub Desktop
+
+1. **Create A Local Copy**
+
+ 1. **File** -> **Clone Repository...**
+ 2. Select your fork, `YOUR_USERNAME\hugo-future-imperfect`
+ 3. Choose your local path
+ 4. Press **Clone**
+
+ You have now cloned your fork to the location specified.
+
+2. **Syncing Fork with Original** and **Keeping it Synced**
+
+ This is currently not possible via GitHub Desktop, but is on the feature list
+ for [v1.1][GitHub Desktop 1.1]. Keep an eye out for that release.
+
+ In the meantime, the *best* way to stay in sync is to create a pull request
+ where the `base fork` is `YOUR_USERNAME/hugo-future-imperfect` and the `head
+ fork` is `jpescador/hugo-future-imperfect`.
+
+## Creating an Issue Ticket
+
+When you go to create an issue ticket, you will notice [a template][issue template]
+appears. Please adhere to this for the sake of consistency and organization. A
+couple of things to note from that template are:
+
+1. **Check all the prerequisites**
+
+ Make sure you have done all the steps at the top before submitting the issue
+ ticket. Redundancy can easily clutter the repository meaning less time
+ working on the theme and more time having to do clean-up. They are as follows:
+
+ - [ ] I am running the [latest version of Hugo][Hugo Release]
+ - [ ] I am using the [latest version of Hugo-Future-Imperfect][Theme Sync]
+ - [ ] I checked the [documentation] and found no answer
+ - [ ] I checked the [issues][All Issues] to make sure that this issue has not
+ already been filed
+
+2. **Be very clear with your descriptions.**
+
+ Err on the side of too much information. It helps track the problem down
+ quicker or figure out how to implement it easier.
+
+## Creating a Pull Request
+
+In an effort to increase simplicy of the theme, we are going to try to implement
+this [branching model]. For most people, this will be common sense. If you are
+new to Git, it's a good read that explains it well concisely.
+
+When contributing to the project, please keep your `master` branch in sync with
+the upstream `master` branch. Each new feature should have a new branch labeled
+`my-feature`, `feature-fix`, or a similarly descriptive label. If you would like
+to have a personal `master` branch, please label it whatever you'd like, but
+preferably `YOUR_USERNAME`. This helps keep track of all changes and keeps the
+[network] clean and easy to navigate. This is especially useful if some decides
+to fork on their own, but may implement features we may want for the original.
+
+When you go to create a pull request, you will also notice [a template][Pull Request Template]
+appears. Again, please adhere to this for the sake of consistency and
+organization. A couple of things to note from that template are:
+
+1. **Check all the prerequisites**
+
+ Make sure you have done all the steps at the top before submitting the pull
+ request. Redundancy can easily clutter the repository meaning less time
+ working on the theme and more time having to do clean-up. They are as follows:
+
+ - [ ] I am running the [latest version of Hugo][Hugo Release]
+ - [ ] I am using the [latest version of Hugo-Future-Imperfect][Theme Sync]
+ - [ ] I checked the [issues][All Issues]
+ to make sure that this feature has not been rejected before
+ - [ ] I checked the [pull requests][All Pull Requests]
+ to make sure that this feature is not already being developed
+
+2. **Always include any related issues**
+
+ Make sure in the comments that you include any issues this closes by writing
+ `Closes #XXX` under *Motivation and Context*. This will automatically close
+ the issue when the pull request is accepted.
+
+## Style Guide
+
+For the sake of consistency, please use the [Google HTML 5 and CSS 3 Style Guide].
+
+You will notice that a large portion of the theme does not adhere to this style
+guide. The original HTML 5 UP theme uses 4 space tabs instead of 2 space tabs.
+This, again, adds to bloat, especially when using Hugo functions. If you are
+making a change to a file, please go ahead and fix any styling in the region
+relative to where you are working. This will help us slowly fix the theme. Once
+theme theme becomes more active with people constantly resyncing, we can look at
+doing an across the board change (we might actually look at doing this as part
+of [v0.30][Next Release] since that will be a rather large change requiring
+everyone to resync).
+
+
+## Thank You
+
+Thank you again for your interest in contributing to the theme. Feel free to ask
+any questions you may have. We are here to help.
+
+<!--- Project Specific References -->
+
+[Issue Template]: https://github.com/jpescador/hugo-future-imperfect/blob/master/.github/ISSUE_TEMPLATE.md
+[Issues]: https://github.com/jpescador/hugo-future-imperfect/issues
+[All Issues]: https://github.com/jpescador/hugo-future-imperfect/issues?utf8=%E2%9C%93&q=is%3Aissue
+[Pull Request Template]: https://github.com/jpescador/hugo-future-imperfect/blob/master/.github/PULL_REQUEST_TEMPLATE.md
+[Pull Requests]: https://github.com/jpescador/hugo-future-imperfect/pulls
+[All Pull Requests]: https://github.com/jpescador/hugo-future-imperfect/pulls?utf8=%E2%9C%93&q=is%3Apr
+[Contributors]: https://github.com/jpescador/hugo-future-imperfect/graphs/contributors
+[Documentation]: https://github.com/jpescador/hugo-future-imperfect/wiki
+[Head]: https://github.com/jpescador/hugo-future-imperfect
+[Network]: https://github.com/jpescador/hugo-future-imperfect/network
+[Next Release]: https://github.com/jpescador/hugo-future-imperfect/milestone/1
+[Projects]: https://github.com/jpescador/hugo-future-imperfect/projects
+[Theme Sync]: #syncing
+
+<!--- External References -->
+
+[Branching Model]: http://nvie.com/posts/a-successful-git-branching-model/
+[Git]: https://git-scm.com/downloads
+[GitHub Account]: https://github.com/login
+[GitHub Authentication]: https://help.github.com/articles/set-up-git#next-steps-authenticating-with-github-from-git
+[GitHub Desktop]: https://desktop.github.com/
+[GitHub Desktop 1.1]: https://github.com/desktop/desktop/milestone/11
+[GitHub Git]: https://help.github.com/articles/set-up-gi
+[Google HTML 5 and CSS 3 Style Guide]: https://google.github.io/styleguide/htmlcssguide.html
+[Hugo Release]: https://github.com/gohugoio/hugo/releases
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index c79ccaa..a4afc0e 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,24 +1,43 @@
-# Title
+<!--- Prerequisites -->
+<!--- Please answer yes the following statements before submitting an issue -->
+<!--- I am running the latest version of [Hugo](https://github.com/gohugoio/hugo/releases) -->
+<!--- I am using the latest version of [Hugo-Future-Imperfect](https://github.com/jpescador/hugo-future-imperfect/releases) -->
+<!--- I checked the [documentation](https://github.com/jpescador/hugo-future-imperfect/wiki) and found no answer -->
+<!--- I checked the [issues](https://github.com/jpescador/hugo-future-imperfect/issues?utf8=%E2%9C%93&q=is%3Aissue) to make sure that this issue has not already been filed -->
-Please make your title brief, yet descriptive. Make it clear whether its either a bug, feature, question, etc.
+<!--- Provide a general summary of the issue in the Title above -->
-# Prerequisites
+## Expected Behavior
+<!--- If you're describing a bug, tell us what should happen -->
+<!--- If you're suggesting a change/improvement, tell us how it should work -->
-Please answer the following questions for yourself before submitting an issue.
+## Current Behavior
+<!--- If describing a bug, tell us what happens instead of the expected behavior -->
+<!--- If suggesting a change/improvement, explain the difference from current behavior -->
-- [ ] I am running the latest version of [Hugo](https://github.com/gohugoio/hugo/releases)
-- [ ] I am using the latest version of [Hugo-Future-Imperfect](https://github.com/jpescador/hugo-future-imperfect/releases)
-- [ ] I checked the [documentation](https://github.com/jpescador/hugo-future-imperfect/wiki) and found no answer
-- [ ] I checked the [issues](https://github.com/jpescador/hugo-future-imperfect/issues?utf8=%E2%9C%93&q=is%3Aissue) to make sure that this issue has not already been filed
+## Possible Solution
+<!--- Not obligatory, but suggest a fix/reason for the bug, -->
+<!--- or ideas how to implement the addition or change -->
-**YOU MAY DELETE THE TITLE PREREQUISITES SECTIONS.**
+## Steps to Reproduce or Template with Error (for bugs)
+<!--- Provide a link to a live example, or an unambiguous set of steps to -->
+<!--- reproduce this bug. Include code to reproduce, if relevant -->
+1.
+2.
+3.
+4.
----
+## Context
+<!--- How has this issue affected you? What are you trying to accomplish? -->
+<!--- Providing context helps us come up with a solution that is most useful in the real world -->
-# Feature or Expected Behavior
+## Your Environment
+<!--- Include as many relevant details about the environment you experienced the bug in -->
-Please describe the behavior you are expecting, or feature that you are requesting. Please be as detailed as possible. Feel free to include code snippets.
+**Hugo Version:**
-# Current Behavior
+**Browser:**
-What is the current behavior? Which templates are the source of the issue?
+**Desktop or Mobile:**
+
+**Link to your project:**
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 0000000..0b8f32c
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,45 @@
+<!--- Prerequisites -->
+<!--- I am running the latest version of [Hugo](https://github.com/gohugoio/hugo/releases) -->
+<!--- I am using the latest version of [Hugo-Future-Imperfect](https://github.com/jpescador/hugo-future-imperfect/releases) -->
+<!--- I checked the [issues](https://github.com/jpescador/hugo-future-imperfect/issues?utf8=%E2%9C%93&q=is%3Aissue) to make sure that this feature has not been rejected before -->
+<!--- I checked the [pull requests](https://github.com/jpescador/hugo-future-imperfect/pulls?utf8=%E2%9C%93&q=is%3Apr) to make sure that this feature is not already being developed -->
+
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+<!--- Describe your changes in detail -->
+
+## Motivation and Context
+<!--- Why is this change required? What problem does it solve? -->
+<!--- If it fixes an open issue, please link to the issue here with "Closes #XXX" -->
+
+## How Has This Been Tested?
+<!--- Please describe in detail how you tested your changes. -->
+<!--- Include details of your testing environment, and the tests you ran to -->
+<!--- see how your change affects other areas of the code, etc. -->
+
+**Hugo Version:**
+
+**Browser(s):**
+
+## Screenshots (if appropriate):
+
+## Types of changes
+<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
+<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->
+
+- [ ] My code follows the [code style] of this project.
+- [ ] My change requires a change to the [documentation].
+- [ ] I have updated the documentation, including `theme.toml`, accordingly.
+- [ ] I have read the [Contributing Document].
+
+[Code Style]: https://github.com/jpescador/hugo-future-imperfect/blob/master/.github/CONTRIBUTING.md#Style-Guide
+[Contributing Document]: https://github.com/jpescador/hugo-future-imperfect/blob/master/.github/CONTRIBUTING.md
+[Documentation]: https://github.com/jpescador/hugo-future-imperfect/wiki
diff --git a/images/screenshot.png b/images/screenshot.png
index 538bf4d..844d0a8 100644
--- a/images/screenshot.png
+++ b/images/screenshot.png
Binary files differ
diff --git a/images/tn.png b/images/tn.png
new file mode 100644
index 0000000..f7b0fb3
--- /dev/null
+++ b/images/tn.png
Binary files differ