Skip to content

Commit

Permalink
docs: update community standards and contributing guidelines (#87)
Browse files Browse the repository at this point in the history 
* docs: update community standards and contributing guidelines

* docs: update links

* docs: generalize verbiage
  • Loading branch information
@bhajneet
bhajneet authored Feb 22, 2023
1 parent 8181548 commit 5820f58
Show file tree
Hide file tree
Showing 12 changed files with 287 additions and 523 deletions.
89 changes: 7 additions & 82 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,100 +1,25 @@
# Contributing to Docs
# Contributing

Thank you for your interest in participating!
Anyone providing assistance to the future of Shabad OS is considered a contributor. By participating, you agree to abide by our Code of Conduct, the [Contributor Covenant](https://docs.shabados.com/community/code-of-conduct).

There are many ways to contribute, beyond writing code or programming, by: logging bugs, reporting issues, and creating suggestions. To do so, please [create a ticket](https://github.com/shabados/docs/issues/new) in our issue tracker. See other ways to [Contribute](README.md#Contributing) or give [Feedback](README.md#Feedback).
Thank you for your interest in participating! Please see our [community docs on contributing](https://docs.shabados.com/community/contributing).

If you're interested in creating or changing documentation, please see [EDITING.md](EDITING.md).
This document is for developers or programmers contributing to source code. If you're interested in contributing a different way, please see the link above.

This document is for developers or programmers contributing to the source code of Docs.

**Table of Contents**

- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Build](#build)
- [Start](#start)
- [Run](#run)
- [Workflow](#workflow)
- [Coding Guidelines](#coding-guidelines)
- [Scope](#scope)
- [Thank you](#thank-you)

## Getting Started

If you wish to better understand how `docs` works or want to debug an issue: get the source, build it, and run it locally.

### Prerequisites

In order to download necessary tools, clone the repository, and install dependencies, you'll need network access.

You'll need the following:
## Prerequisites

- [Git](https://git-scm.com/)
- [Node.JS](https://nodejs.org) (If you need to manage multiple Node.JS versions, [use a node version manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) to install)

Get the source code of `docs` repo:

```shell
gh repo fork shabados/docs --clone=true
```

**PROTIP**: Use the [`gh` cli tool from GitHub](https://cli.github.com/) to fork the repo to your GitHub account (if not already), clone it to your local machine, and set the appropriate remotes for origin and upstream with the above command.

### Build

Run `npm i` in the root directory.

### Start
## Build

```shell
npm install
npm start
```

### Run

Usage:

```shell
npm run <command>
```

The commands are:

```shell
start # Builds and serves a preview of site locally with Webpack Dev Server
build # Compiles site for production
serve # Serve built website locally
swizzle # Customizing any Docusaurus theme components
clean # Clear generated assets, caches, build artifacts
lint # ESLint to check code style issues and Prettier in check mode to check non JS/TS files
lint:format # Run prettier and then eslint to fix code style issues
```

Run `npm run` or open the `package.json` file(s) for a full list of commands.

## Workflow

The workflow of development (or Git Flow) is to [choose/create an issue](https://github.com/shabados/docs/issues) to work on, [create a feature branch](https://github.com/shabados/.github/wiki/How-to-Contribute#branches), and [submit a pull request](https://github.com/shabados/.github/wiki/How-to-Contribute#pull-requests).

**PROTIP**: Read more about our workflow (issue tracking, branching, and pull requests) in the [How To Contribute wiki article](https://github.com/shabados/.github/wiki/How-to-Contribute).

### Coding Guidelines

Please see the [wiki](https://github.com/shabados/.github/wiki/How-to-Contribute#coding-guidelines) for Coding Guidelines ([Names](https://github.com/shabados/.github/wiki/How-to-Contribute#41-names), [Comments](https://github.com/shabados/.github/wiki/How-to-Contribute#42-comments), [Style](https://github.com/shabados/.github/wiki/How-to-Contribute#43-style), [Linting](https://github.com/shabados/.github/wiki/How-to-Contribute#44-linting), and [Commit Messages](https://github.com/shabados/.github/wiki/How-to-Contribute#45-commit-messages)).

### Scope

To be used in [commit messages](https://github.com/shabados/.github/wiki/How-to-Contribute#45-commit-messages).

Usage:

```shell
<type>(<scope>): <subject>
```

Until the project matures further, there will be no scope requirements in commit messages for `docs`.

## Thank you

Your contributions to open source, large or small, make great projects like this possible. Thank you for taking the time to participate in this project.
85 changes: 3 additions & 82 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1,100 +1,21 @@
<img src="https://raw.githubusercontent.com/shabados/presenter/dev/resources/icon.png" width="128" alt="Shabad OS">

# Docs

User guides, quick-references, developer best practices, and other Shabad OS related documentation

[![Release][release-image]][release-url]
[![Powered by Vercel][vercel-image]][vercel-url]

**Table of contents**

- [Introduction](#introduction)
- [Community](#community)
- [Contributing](#contributing)
- [People](#people)
- [Feedback](#feedback)
- [Related Projects](#related-projects)
- [Code of Conduct](#code-of-conduct)
- [License](#license)

## Introduction

User guides, quick-references, developer/contributor best practices, etc.

## Community

Get updates on Shabad OS and chat with the project maintainers and community members.

- [![Instagram][instagram-image]][instagram-url] Follow Shabad OS on Instagram
- [![Twitter][twitter-image]][twitter-url] Follow Shabad OS on Twitter.
- [![Chat][chat-image]][chat-url] Join the official Slack channel.

## Contributing

There are multiple ways to contribute whether you are a user or developer. For example:

- [Submit bugs and feature requests][new-issue-url].
- [Review documentation and make pull requests](EDITING.md) for anything from typos to new content.
- Give feedback on the onboarding process to make it easier for others to join the project.
If you're interested in contributing to source code, then please see [Contributing](./CONTRIBUTING.md).

If you're interested in contributing to the source code of `docs`, then please see [Contributing Guidelines](./CONTRIBUTING.md).
If you're otherwise interested in participating with a Shabad OS project, then please see our [community docs on contributing](https://docs.shabados.com/community/contributing).

## People

The original author and current lead maintainer is Saihajpreet Singh ([@saihaj](https://github.com/saihaj)).
The original author is [@saihaj](https://github.com/saihaj).

"Thank you!" to [all the volunteers][contributor-url] who've contributed to `docs`.

## Feedback

- Ask questions and get help in our community chat via [Slack][chat-url]
- [Upvote popular feature requests][upvote-tracker-url] using the thumbs-up/+1 reaction on the first post of a feature request
- Follow [@shabad_os on Instagram](instagram-url) and [@shabad_os on Twitter](twitter-url) and let us know what you think!

## Related Projects

Projects in the Shabad OS ecosystem of free and open source software include:

- [Database](https://github.com/shabados/database)
- [Viewer](https://github.com/shabados/viewer)
- [Presenter](https://github.com/shabados/presenter)
- [Mobile](https://github.com/shabados/mobile)
- [Gurmukhi Utils](https://github.com/shabados/gurmukhi-utils)

## Code of Conduct

Please note that this project is released under the Contributor Covenant. By participating in this project you agree to abide by its terms. Our intention is to signal a safe open-source community by welcoming all people to contribute, and pledging in return to value them as whole human beings and to foster an atmosphere of kindness, cooperation, and understanding.

> 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.
>
> [The Contributor Covenant][contributor-covenant-url]
## License

This project is under v3 of the [GPL](LICENSE.md). It is similar to the Golden Rule: do unto others as you would have them do unto you. In exchange for benefitting from the work completed in this repo, others must share their derivative work under v3 of the [GPL](LICENSE.md).

> This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
>
> This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
>
> You should have received a copy of the GNU General Public License along with this program. If not, see <https://www.gnu.org/licenses/>.
Docusaurus v2 is under the MIT license. [Learn more about Docusaurus >](https://v2.docusaurus.io/)

[release-image]: https://img.shields.io/github/workflow/status/shabados/docs/Continuous%20Deployment/main.svg?label=release
[release-url]: https://github.com/shabados/docs/actions?query=workflow%3A%22Continuous+Deployment%22+branch%3Amain
[vercel-image]: https://img.shields.io/badge/▲-Powered%20by%20Vercel-000?labelColor=000
[vercel-url]: https://vercel.com/?utm_source=ShabadOS&utm_campaign=oss
[instagram-image]: https://img.shields.io/badge/Instagram-%40shabad__os-C13584.svg?logo=instagram&logoColor=white
[instagram-url]: https://www.instagram.com/shabad_os/
[twitter-image]: https://img.shields.io/badge/Twitter-%40shabad__os-1DA1F2.svg?logo=twitter&logoColor=white
[twitter-url]: https://www.twitter.com/shabad_os/
[chat-image]: https://img.shields.io/badge/Chat-Public%20Slack%20Channels-1264a3.svg?logo=slack
[chat-url]: https://chat.shabados.com
[new-issue-url]: https://github.com/shabados/docs/issues/new/choose
[contributor-url]: https://github.com/shabados/docs/graphs/contributors
[upvote-tracker-url]: https://github.com/shabados/docs/issues?q=is%3Aopen+is%3Aissue+label%3A%22Type%3A+Feature%2FEnhancement%22+sort%3Areactions-%2B1-desc
[contributor-covenant-url]: https://www.contributor-covenant.org/version/2/0/code_of_conduct/
137 changes: 137 additions & 0 deletions content/community/code-of-conduct.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
---
title: Contributor Covenant Code of Conduct
sidebar_label: 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, caste, color, 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:

[email protected]

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.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][mozilla coc].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][faq]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[mozilla coc]: https://github.com/mozilla/diversity
[faq]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
Loading

0 comments on commit 5820f58

Please sign in to comment.