The Open Source DocuSign Alternative.
TypeScript digital-signaturedocument-signingdocusign-alternativee-signatureesignesignaturenext-authnextjsopen-sourcepades-standardpdfpdf-signpdf-signaturepostgresqlprismaself-hostedsigningtypescript
chore: add code of conduct (#521)
David Nguyene0662ce024d2
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.mdnew file mode 100644index 000000000..5cf6aad4e--- /dev/null+++ b/CODE_OF_CONDUCT.md@@ -0,0 +1,126 @@+# 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, 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+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].diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex dd7fc4349..43a641f8f 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -9,6 +9,22 @@ If you plan to contribute to Documenso, please take a moment to feel awesome ✨- Consider the results from the discussion in the issue- Accept the [Contributor License Agreement](https://documen.so/cla) to ensure we can accept your contributions.+## Taking issues++Before taking an issue, ensure that:++- The issue has been assigned the public label+- The issue is clearly defined and understood+- No one has been assigned to the issue+- No one has expressed intention to work on it++You can then:++1. Comment on the issue with your intention to work on it+2. Begin work on the issue++Always feel free to ask questions or seek clarification on the issue.+## DevelopingThe development branch is <code>main</code>. All pull request should be made against this branch. If you need help getting started, [join us on Discord](https://documen.so/discord).diff --git a/README.md b/README.mdindex d515c6f33..10414fc04 100644--- a/README.md+++ b/README.md@@ -27,6 +27,7 @@<a href="https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/documenso/documenso"><img alt="open in devcontainer" src="https://img.shields.io/static/v1?label=Dev%20Containers&message=Enabled&color=blue&logo=visualstudiocode" /></a>+ <a href="code_of_conduct.md"><img src="https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg" alt="Contributor Covenant"></a></p>> 🦺 Documenso 1.0 is deployed to our <a href="https://documen.so/staging" target="_blank">Staging Environment</a>.@@ -130,14 +131,12 @@ git clone https://github.com/documenso/documenso2. Set up your `.env` file using the recommendations in the `.env.example` file. Alternatively just run `cp .env.example .env` to get started with our handpicked defaults.-3. Run `npm run dx` in the root directory- This will spin up a postgres database and inbucket mailserver in a docker container.4. Run `npm run dev` in the root directory-5. Want it even faster? Just use```sh@@ -170,14 +169,15 @@ git clone https://github.com/documenso/documenso3. Create your `.env` from the `.env.example`. You can use `cp .env.example .env` to get started with our handpicked defaults.4. Set the following environement variables.- - NEXTAUTH_URL- - NEXTAUTH_SECRET- - NEXT_PUBLIC_WEBAPP_URL- - NEXT_PUBLIC_MARKETING_URL- - NEXT_PRIVATE_DATABASE_URL- - NEXT_PRIVATE_DIRECT_DATABASE_URL- - NEXT_PRIVATE_SMTP_FROM_NAME- - NEXT_PRIVATE_SMTP_FROM_ADDRESS++ - NEXTAUTH_URL+ - NEXTAUTH_SECRET+ - NEXT_PUBLIC_WEBAPP_URL+ - NEXT_PUBLIC_MARKETING_URL+ - NEXT_PRIVATE_DATABASE_URL+ - NEXT_PRIVATE_DIRECT_DATABASE_URL+ - NEXT_PRIVATE_SMTP_FROM_NAME+ - NEXT_PRIVATE_SMTP_FROM_ADDRESS5. Create the database schema by running `npm run prisma:migrate-dev -w @documenso/prisma`