From 5b15069b3af7a0f32329417d02afcfdcbd5b7ce4 Mon Sep 17 00:00:00 2001 From: mrbernnz Date: Mon, 15 Jan 2018 09:02:40 -0500 Subject: [PATCH] * Required Open Source files. --- .editorconfig | 36 ++++++++++++++++ .github/code-of-conduct.md | 73 ++++++++++++++++++++++++++++++++ .github/contributing.md | 49 +++++++++++++++++++++ .github/issue_template.md | 36 ++++++++++++++++ .github/pull_request_template.md | 36 ++++++++++++++++ .gitignore | 64 ++++++++++++++++++++++++++-- README.md | 1 + 7 files changed, 292 insertions(+), 3 deletions(-) create mode 100644 .editorconfig create mode 100644 .github/code-of-conduct.md create mode 100755 .github/contributing.md create mode 100755 .github/issue_template.md create mode 100755 .github/pull_request_template.md diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 000000000..2ba3e5b9b --- /dev/null +++ b/.editorconfig @@ -0,0 +1,36 @@ + + +# EditorConfig is awesome: http://EditorConfig.org + +# top-most EditorConfig file +root = true + +# Unix-style newlines with a newline ending every file +[*] +end_of_line = lf +insert_final_newline = true + +# Matches multiple files with brace expansion notation +# Set default charset +[*.{js,py}] +charset = utf-8 + +# 4 space indentation +[*.py] +indent_style = space +indent_size = 4 + +# Tab indentation (no size specified) +[Makefile] +indent_style = tab + +# Indentation override for all JS under lib directory +[lib/**.js] +indent_style = space +indent_size = 2 + +# Matches the exact files either package.json or .travis.yml +[{package.json,.travis.yml}] +indent_style = space +indent_size = 2 + diff --git a/.github/code-of-conduct.md b/.github/code-of-conduct.md new file mode 100644 index 000000000..45904febb --- /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, +education, socio-economic status, 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 [INSERT EMAIL ADDRESS]. 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 100755 index 000000000..78ca22c01 --- /dev/null +++ b/.github/contributing.md @@ -0,0 +1,49 @@ +# Contributing + +These are just guidelines, not rules, use your best judgment and feel free to propose changes to this document in a pull request. + +## What should I know before I get started? + +### Code of Conduct + +This project adheres to the Contributor Covenant [code of conduct](https://github.com/Vets-Who-Code/vwc-site/blob/master/.github/code-of-conduct.md). +By participating, you are expected to uphold this code. +Please report unacceptable behavior to [admin](mailto:admin@vetswhocode.io). + +## How Can I Contribute? + +### Reporting Bugs + +This section guides you through submitting a bug report for Censible. Following these guidelines helps maintainers understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:. + +When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). If you'd like, you can use [this template](#template-for-submitting-bug-reports) to structure the information. + +#### Before Submitting A Bug Report + +* **Perform a [cursory search](https://github.com/issues?q=+is%3Aissue+user%3AVets-Who-Code)** to see if the problem has already been reported. If it has, add a comment to the existing issue instead of opening a new one. + +#### How Do I Submit A (Good) Bug Report? + +Bugs are tracked as [GitHub issues](https://guides.github.com/features/issues/). + +Explain the problem and include additional details to help maintainers reproduce the problem: + +* **Use a clear and descriptive title** for the issue to identify the problem. +* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started Atom, e.g. which command exactly you used in the terminal, or how you started Atom otherwise. When listing steps, **don't just say what you did, but explain how you did it**. For example, if you moved the cursor to the end of a line, explain if you used the mouse, or a keyboard shortcut or an Atom command, and if so which one? +* **Provide specific examples to demonstrate the steps**. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks](https://help.github.com/articles/markdown-basics/#multiple-lines). +* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior. +* **Explain which behavior you expected to see instead and why.** +* **Include screenshots and animated GIFs** which show you following the described steps and clearly demonstrate the problem. You can use [this tool](http://www.cockos.com/licecap/) to record GIFs on OSX and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. +* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below. + +Provide more context by answering these questions: + +* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens. +* If the problem is related to working with files (e.g. opening and editing files), **does the problem happen for all files and projects or only some?** Does the problem happen only when working with local or remote files (e.g. on network drives), with files of a specific type (e.g. only JavaScript or Pug files), with large files or files with very long lines, or with files in a specific encoding? Is there anything else special about the files you are using? + +### Pull Requests + +* Include screenshots and animated GIFs in your pull request whenever possible. +* Follow the [Airbnb React/JSX](https://github.com/airbnb/javascript/tree/master/react) styleguide. +* Include thoughtfully-worded, well-structured + [Jest](https://facebook.github.io/jest/) tests in the `./__tests__` folder. Run them using `npm test`. diff --git a/.github/issue_template.md b/.github/issue_template.md new file mode 100755 index 000000000..a812f0ae4 --- /dev/null +++ b/.github/issue_template.md @@ -0,0 +1,36 @@ + + +## Expected Behavior + + + +## Current Behavior + + + +## Possible Solution + + + +## Steps to Reproduce (for bugs) + + +1. + +2. + +3. + +4. + +## Context + + + +## Your Environment + +* Version used: +* Environment name and version (e.g. PHP 5.4 on nginx 1.9.1): +* Server type and version: +* Operating System and version: +* Link to your project: diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100755 index 000000000..fab500439 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,36 @@ + + +## Description + + +## Related Issue + + + + + +## Motivation and Context + + +## How Has This Been Tested? + + + + +## Screenshots (if appropriate): + +## Types of changes + +- [ ] 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: + + +- [ ] My code follows the code style of this project. +- [ ] My change requires a change to the documentation. +- [ ] I have updated the documentation accordingly. +- [ ] I have read the **CONTRIBUTING** document. +- [ ] I have added tests to cover my changes. +- [ ] All new and existing tests passed. diff --git a/.gitignore b/.gitignore index 248335d25..dafa35d4c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,8 +1,66 @@ +### Node ### +# Logs +logs +*.log +npm-debug.log* +yarn-debug.log* +yarn-error.log* + +# Runtime data +pids +*.pid +*.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover +lib-cov + +# Coverage directory used by tools like istanbul +coverage + +# nyc test coverage +.nyc_output + +# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files) +.grunt + +# Bower dependency directory (https://bower.io/) +bower_components + +# node-waf configuration +.lock-wscript + +# Compiled binary addons (http://nodejs.org/api/addons.html) +build/Release + +# Dependency directories +node_modules/ +jspm_packages/ + +# Typescript v1 declaration files +typings/ + +# Optional npm cache directory +.npm + +# Optional eslint cache +.eslintcache + +# Optional REPL history +.node_repl_history + +# Output of 'npm pack' +*.tgz + +# Yarn Integrity file +.yarn-integrity + +# dotenv environment variables file +.env + # Project dependencies -# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git -node_modules .cache/ + # Build directory public/ .DS_Store -yarn-error.log diff --git a/README.md b/README.md index 6aa19222d..efe2212c6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,4 @@ +[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/Vets-Who-Code/vwc-site/blob/master/LICENSE) # Vets Who Code Serverless Web App ## Prerequisites