Improve README adding contributing documents

ferrarafer · FilledStacks · commit 282be3021e56 · 2023-01-25T18:31:03.000+02:00
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,80 @@
+# 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
+* Contacting individual members, contributors, or leaders privately, outside designated community mechanisms, 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 dane@filledstacks.com. 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][homepage], version 2.0, available at <https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at <https://www.contributor-covenant.org/faq>. Translations are available at <https://www.contributor-covenant.org/translations>.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,75 @@
+# Welcome to Stacked docs contributing guide <!-- omit in toc -->
+
+Thank you for investing your time in contributing to our project! Any contribution you make will be reflected on [stacked.filledstacks.com](https://stacked.filledstacks.com/) :sparkles:. 
+
+Read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.
+
+In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
+
+Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
+
+## 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)
+
+## Getting started
+
+Check to see what [types of contributions](/contributing/types-of-contributions.md) we accept before making changes. Some of them don't even require writing a single line of code :sparkles:.
+
+### Issues
+
+#### Create a new issue
+
+If you spot a problem with the docs, [search if an issue already exists](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/FilledStacks/stacked-docs/issues/new/choose). 
+
+#### Solve an issue
+
+Scan through our [existing issues](https://github.com/FilledStacks/stacked-docs/issues) to find one that interests you. You can narrow down the search using `labels` as filters.
+
+### Make Changes
+
+#### Make changes in the UI
+
+Click **Edit this page** at the bottom of any docs page to make small changes such as a typo, sentence fix, or a broken link. This takes you to the `.md` file where you can make your changes and [create a pull request](#pull-request) for a review. 
+
+#### Make changes locally
+
+1. Fork the repository.
+- Using GitHub Desktop:
+  - [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop.
+  - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
+
+- Using the command line:
+  - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
+
+2. Install or update to **Node.js**, at the version 16.14 or above. For more information, see [the development guide](contributing/development.md).
+
+3. Create a working branch and start with your changes!
+
+### Commit your update
+
+Commit the changes once you are happy with them. Don't forget to [self-review](/contributing/self-review.md) to speed up the review process:zap:.
+
+### Pull Request
+
+When you're finished with the changes, create a pull request, also known as a PR.
+- Fill the "Ready for review" template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. 
+- Don't forget to [link PR to issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if you are solving one.
+- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork) so the branch can be updated for a merge.
+Once you submit your PR, a Stacked team member will review your proposal. We may ask questions or request additional information.
+- We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
+- As you update your PR and apply changes, mark each conversation as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations).
+- If you run into any merge issues, checkout this [git tutorial](https://github.com/skills/resolve-merge-conflicts) to help you resolve merge conflicts and other issues.
+
+### Your PR is merged!
+
+Congratulations :tada::tada: The FilledStacks team thanks you :sparkles:. 
+
+Once your PR is merged, your contributions will be publicly visible on the [Stacked docs](https://stacked.filledstacks.com). 
+
+Now that you are part of the Stacked docs community, see how else you can [contribute to the docs](/contributing/types-of-contributions.md).
diff --git a/README.md b/README.md
@@ -1,41 +1,29 @@
-# Website
+# Stacked Docs <!-- omit in toc --> 
+ 
+This repository contains the documentation website code and Markdown source files for [stacked.filledstacks.com](https://stacked.filledstacks.com).
 
-This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.
 
-### Installation
+## Contributing
 
-```
-$ yarn
-```
+See [the contributing guide](CONTRIBUTING.md) for detailed instructions on how to get started with our project. 
 
-### Local Development
+We accept different [types of contributions](./contributing/types-of-contributions.md), including some that don't require you to write a single line of code.
 
-```
-$ yarn start
-```
+On the Stacked Docs site, you can click the edit this page button at the bottom of the page to open a pull request for quick fixes like typos, updates, or link fixes.
 
-This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+For more complex contributions, you can open an issue using the most appropriate [issue template](https://github.com/FilledStacks/stacked-docs/issues/new/choose) to describe the changes you'd like to see.
 
-### Build
+If you're looking for a way to contribute, you can scan through our [existing issues](https://github.com/FilledStacks/stacked-docs/issues) for something to work on. When ready, check out [Getting Started with Contributing](/CONTRIBUTING.md) for detailed instructions.
 
-```
-$ yarn build
-```
+### Join us in discussions
 
-This command generates static content into the `build` directory and can be served using any static contents hosting service.
+We use Slack to talk about all sorts of topics related to Stacked and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in the [Slack](https://filledstacks.slack.com/).
 
-### Deployment
+## License
 
-Using SSH:
+**TODO**: complete by Dane
 
-```
-$ USE_SSH=true yarn deploy
-```
+## Thanks :purple_heart:
 
-Not using SSH:
-
-```
-$ GIT_USER=<Your GitHub username> yarn deploy
-```
-
-If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
+Thanks for all your contributions and efforts towards improving the Stacked documentation. We thank you for being part of our :sparkles: community :sparkles:!
diff --git a/contributing/README.md b/contributing/README.md
@@ -0,0 +1,8 @@
+# Contributing to Stacked docs
+
+Check out our [contributing guide](../CONTRIBUTING.md) to see all the ways you can participate in the Stacked docs community :sparkling_heart:
+
+Here, you'll find additional information that might be helpful as you work on a pull request in this repo.
+
+- [development](./development.md) - steps for getting this app running on your local machine
+- [translation](./translation.md) - steps for translating docs to a different locale
diff --git a/contributing/development.md b/contributing/development.md
@@ -0,0 +1,57 @@
+# Development
+
+This document describes the process for running this application on your local computer.
+
+## Getting started
+
+This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
+
+### Requirements
+
+Node.js version 16.14 or above.
+
+### Installation
+
+In the directory containing package.json, run your package manager's install command:
+
+npm
+```
+$ npm install
+```
+
+yarn
+```
+$ yarn install
+```
+
+### Build
+
+Docusaurus is a modern static website generator so we need to build the website into a directory of static contents and put it on a web server so that it can be viewed. To build the website:
+
+npm
+```
+$ npm run build
+```
+
+yarn
+```
+$ yarn build
+```
+
+and contents will be generated within the /build directory, which can be copied to any static file hosting service like GitHub pages, Vercel or Netlify.
+
+### Running the development server
+
+To preview your changes as you edit the files, you can run a local development server that will serve your website and reflect the latest changes.
+
+npm
+```
+$ npm run start
+```
+
+yarn
+```
+$ yarn start
+```
+
+By default, a browser window will open at http://localhost:3000.
diff --git a/contributing/self-review.md b/contributing/self-review.md
@@ -0,0 +1,10 @@
+### Self Review
+
+You should always review your own PR first.
+
+For content changes, make sure that you:
+
+- [ ] Confirm that the changes meet the user experience and goals outlined in the content design plan (if there is one).
+- [ ] Compare your pull request's source changes to staging to confirm that the output matches the source and that everything is rendering as expected. This helps spot issues like typos, content that doesn't follow the style guide, or content that isn't rendering due to versioning problems. Remember that lists and tables can be tricky.
+- [ ] Review the content for technical accuracy.
+- [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing.
diff --git a/contributing/translation.md b/contributing/translation.md
diff --git a/contributing/types-of-contributions.md b/contributing/types-of-contributions.md
