docs: implement structure template documentation (#1)

docs/authors.md

@@ -0,0 +1,7 @@
+# Authors
+
+## Leads
+
+- Luis Mayta [\@slovacus](https://github.com/luismayta)
+
+## Contributors (chronological)

docs/code_of_conduct.md

@@ -0,0 +1,43 @@
+# 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 <slovacus@gmail.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](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/)

docs/contributing.md

@@ -0,0 +1,91 @@
+# How To Contribute
+
+Contributions to zsh-goenv are welcome.
+
+## Getting Started
+
+### Commits
+
+Follow [semantic commits](https://seesparkbox.com/foundry/semantic_commit_messages) to make `git log`{.interpreted-text role="command"} a little easier to follow.
+
+chore: something just needs to happen, e.g. versioning
+
+docs: documentation pages in `_docs/` or docstrings
+
+feat: new code in `src/`
+
+fix: code improvement in `src/`
+
+refactor: code movement in `src/`
+
+style: aesthetic changes
+
+test: test case modifications in `test/`
+
+Examples commit messages:
+
+- chore: v10.0 (IN-698)
+- docs: Add configuration setting (IN-698)
+- feat: Create Lambda function (IN-698)
+- fix: Retry upload on failure (IN-698)
+- refctor: Extract duplicate code (IN-698)
+- style: isort, YAPF (IN-698)
+- test: Coverage around add permissions (IN-698)
+
+### Branches
+
+Use [slash convention]() with the same leaders as `commits` e.g.:
+
+- (prefix-task)
+
+### Documentation
+
+### Testing
+
+## Code Submission
+
+### Code Improvement
+
+### Code Submission
+
+1.  See if a [Pull Request](https://github.com/hadenlabs/zsh-goenv/pull-requests/) exists
+    - Add some comments or review the code to help it along
+    - Don\'t be afraid to comment when logic needs clarification
+2.  Create a Fork and open a [Pull Request](https://github.com/hadenlabs/zsh-goenv/pull-requests/) if needed
+
+### Code Review
+
+- Anyone can review code
+- Any [Pull Request](https://github.com/hadenlabs/zsh-goenv/pull-requests/) should be closed or merged within a week
+
+### Code Acceptance
+
+Try to keep history as linear as possible using a [rebase] merge strategy.
+
+1. One thumb up at minimum, two preferred
+
+2. Request submitter to [rebase]{.title-ref} and resolve all conflicts
+
+   ```{.bash}
+   # Update `develop`
+   git checkout develop
+   git pull origin develop
+
+   # Update `IN-698` Branch
+   git flow feature start IN-698
+   git rebase develop
+
+   # Update remote Branch and Pull Request
+   git push -f
+   ```
+
+3. Merge the new feature
+
+   ```{.bash}
+   # Merge `IN-698` into `develop`
+   git checkout develop
+   git merge --ff-only feature/IN-698
+   git push
+   ```
+
+4. Delete merged Branch

docs/index.md

@@ -0,0 +1 @@
+# Welcome to zsh-goenv documentation

docs/releasing.md

@@ -0,0 +1,15 @@
+# Releasing
+
+## Bump a new version
+
+Make a new version of zsh-goenv in the following steps:
+
+- Make sure everything is commit to github.com.
+- Update `CHANGELOG.md` with the next version.
+
+- Dry Run: `bumpversion --dry-run --verbose --new-version 0.8.1 patch`
+- Do it: `bumpversion --new-version 0.8.1 patch`
+- \... or: `bumpversion --new-version 0.9.0 minor`
+- Push it: `git push --tags`
+
+See the [bumpversion](https://pypi.org/project/bumpversion/) documentation for details.

docs/support.md

@@ -0,0 +1 @@
+# Support & Contact

docs/testing.md

@@ -0,0 +1,5 @@
+# Testing
+
+## Running tests
+
+## Running tests Syntax

docs/troubleshooting.md

@@ -0,0 +1,11 @@
+# Troubleshooting
+
+## Environment
+
+### Wrong pre-commit with pyenv
+
+Execute the next:
+
+```{.bash}
+make environment
+```

mkdocs.yml

@@ -0,0 +1,24 @@
+site_name: zsh-goenv Documentation
+theme: 'material'
+markdown_extensions:
+  - toc:
+      permalink: True
+  - admonition
+  - smarty
+  - wikilinks
+  - codehilite:
+      linenums: True
+extra:
+  palette:
+    primary: '#087da1'
+    accent: '#00a889'
+  font:
+    text: 'Source Sans Pro'
+
+repo_name: 'hadenlabs/zsh-goenv'
+repo_url: 'https://github.com/hadenlabs/zsh-goenv'
+copyright: 'Copyright © 2020 <a href="https://hadenlabs.com">hadenlabs</a>'
+
+google_analytics:
+  - ''
+  - 'auto'