Merge pull request #22 from Dog-Face-Development/willtheorangeguy-community-docs

Add community documentation

Author: willtheorangeguy

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## [v0.1.0](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/releases/tag/v0.1.0)
+
+### Added
+
+- Workflows and legal documentation.

CODE_OF_CONDUCT.md

@@ -0,0 +1,121 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at the project's
+[Discord](https://discord.gg/73azSgcNYt).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org),
+version 2.0.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to the Dog Face Development Co. Code Style Guide
+
+🎉 Thanks for taking the time to contribute! 🎉
+
+The following is a set of guidelines for contributing to Dog Face Development Co.'s Code Style Guide project on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+## Code of Conduct
+
+This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to our [Discord](https://discord.gg/73azSgcNYt).
+
+## Signing the CLA
+
+If you are not an employee of Dog Face Development Co. and want to submit a pull request to our open source project, you must first sign a Contributor License Agreement (CLA). This allows you to retain your ownership of the code submitted while granting Dog Face Development the necessary legal rights to use your contribution. The CLA only needs to be signed once and it covers all our projects. Follow these simple steps to sign:
+
+- If you are creating a pull request on your own, read the [Individual CLA](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/v0.1.0/docs/legal/CLA_INDIVIDUAL.md). If you are creating a pull request as part of your employment, read the [Entity CLA](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/blob/v0.1.0/docs/legal/CLA_ENTITY.md).
+- Open a [pull request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare).
+- The CLA Assistant bot will ask you to sign the pull request by writing the following text: `I have read the CLA Document, and I hereby sign the CLA.` If you agree to the CLA, copy the text.
+- The CLA Assistant bot will mark your pull request as CLA approved, and you won't have to sign the CLA again!
+
+## New Contributor Guide
+
+To get an overview of the project, read the [README](README.md). Here are some resources to help you get started with open source contributions:
+
+- [Finding ways to contribute to open source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github).
+- [Set up Git](https://docs.github.com/en/get-started/quickstart/set-up-git).
+- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow).
+- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests).
+
+Please contribute using [GitHub Flow](https://guides.github.com/introduction/flow). Create a branch, add commits, and [open a pull request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare).
+
+## How to Contribute
+
+### Did you find a bug?
+
+- **Ensure the bug was not already reported** by searching on GitHub under [Issues](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues).
+- If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues/new/choose). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+- Use the issue templates to create the issue. They include step by step guidelines and have lists of things that should be included.
+
+### Did you write a patch that fixes a bug or updates the documentation?
+
+- Open a new [Pull Request](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/compare) on GitHub with the patch.
+- Ensure the pull request description clearly describes the problem and solution. Be sure to include a **title**, and as much relevant information as possible. Include the relevant issue number if applicable.
+
+### Did you fix whitespace, format code, or make a purely cosmetic patch?
+
+- Changes that are cosmetic in nature and do not add anything substantial to the stability, functionality, or testability of the Style Guides are still accepted! Just follow the same instructions as above.
+- However, do ensure that any cosmetic changes follow the Dog Face Development Co. Style Guides, found [below](#style).
+
+### Do you intend to add a new feature or change an existing one?
+
+- **Ensure the feature was not already introduced** by searching on GitHub under [Issues](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues). Look for those under the [enhancement](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) tag.
+- If you're unable to find an open issue addressing the new feature, [open a new one](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues/new/choose)!
+
+### Do you have questions about the source code?
+
+- Ask any question about how to use the Style Guides on our [Discord](https://discord.gg/73azSgcNYt).
+- If it does not get answered, open an [issue](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide/issues/new/choose).  
+
+## Coding Conventions
+
+Start reading our code and you'll get the hang of it.
+
+- A CLA must be signed before contributing (see [above](#signing-the-cla)).
+- We indent using four spaces (NOT tabs).
+- Every function or piece of code should be heavily commented.
+- We use [Semantic Versioning](https://semver.org/).
+
+## Style
+
+While contributing to a Dog Face Development Co. project, make sure your code follow our [Code Style Guide](https://github.com/Dog-Face-Development/DFD-Code-Style-Guide), and any web design elements follow our [Web Style Guide](https://github.com/Dog-Face-Development/DFD-Web-Style-Guide). If you have any changes you wish to make to the styling of our code or web projects, open an issue or pull request on the respective style guide!
+
+## Attribution
+
+This document is adapted from the Contributing documents of [Rails](https://github.com/rails/rails/blob/main/CONTRIBUTING.md), the [GitHub Docs](https://github.com/github/docs/blob/main/CONTRIBUTING.md), [Atom](https://github.com/atom/atom/blob/master/CONTRIBUTING.md), and [OpenGovernment](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md?plain=1).