Skip to content

Commit e791129

Browse files
greentfrappgreentfrapp
committed
Add contributing docs
1 parent 3ff664b commit e791129

File tree

2 files changed

+233
-0
lines changed

2 files changed

+233
-0
lines changed

‎CODE_OF_CONDUCT.md

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
[email protected].
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series
86+
of actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or
93+
permanent ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within
113+
the community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.0, available at
119+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
120+
121+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
122+
enforcement ladder](https://github.com/mozilla/diversity).
123+
124+
[homepage]: https://www.contributor-covenant.org
125+
126+
For answers to common questions about this code of conduct, see the FAQ at
127+
https://www.contributor-covenant.org/faq. Translations are available at
128+
https://www.contributor-covenant.org/translations.

‎CONTRIBUTING.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
# Contributing to Dashibase
2+
3+
Thank you for your interest in Dashibase! Before you begin, be sure to check out the [code of conduct](https://github.com/dashibase/lotion/blob/main/CODE_OF_CONDUCT.md) and the [existing issues](https://github.com/dashibase/lotion/issues).
4+
5+
## Prelude
6+
7+
Dashibase is written with the following frameworks and tools:
8+
9+
- [Vue 3](https://vuejs.org/)
10+
- [TypeScript](https://www.typescriptlang.org/)
11+
- [Tailwind CSS](https://tailwindcss.com/)
12+
- [Headless UI](https://headlessui.dev/)
13+
- [Oh, Vue Icons!](https://oh-vue-icons.js.org/)
14+
- [Vitest](https://vitest.dev/)
15+
- [Playwright](https://playwright.dev/)
16+
17+
We strongly encourage contributors to be familiarized with these tools.
18+
19+
## Initial Setup
20+
21+
### Installing Dependencies
22+
23+
Before you can start helping with Dashibase, you will want to install and configure the following dependencies on your
24+
machine:
25+
26+
* [Git](http://git-scm.com/)
27+
28+
* [Node.js v16.x (LTS)](http://nodejs.org)
29+
30+
* [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
31+
32+
### Forking Supabase on GitHub
33+
34+
To contribute code to Dashibase, you need to fork the [repository](https://github.com/dashibase/lotion).
35+
36+
## Setup Dashibase on Your Computer
37+
38+
### Clone the Repository
39+
40+
To build Dashibase, you clone your fork of the repository:
41+
42+
2. Clone your GitHub forked repository:
43+
```sh
44+
git clone https://github.com/<github_username>/lotion.git
45+
```
46+
47+
3. Go to the Lotion directory:
48+
```sh
49+
cd lotion
50+
```
51+
52+
### Installing Dependencies
53+
54+
Install npm dependencies:
55+
56+
```sh
57+
npm i
58+
```
59+
60+
## Start a Development Server
61+
62+
1. Start development server
63+
64+
```sh
65+
npm run dev
66+
```
67+
68+
2. To access the local server, enter the following URL into your web browser:
69+
70+
```sh
71+
http://localhost:5173/
72+
```
73+
74+
## Writing Tests
75+
76+
1. Run tests
77+
78+
First, familiarize yourself with the libraries we are using for tests.
79+
80+
Lotion uses [**Vitest**](https://vitest.dev) for unit and component tests, as well as [**Playwright**](https://playwright.dev) for e2e tests.
81+
82+
After cloning the repository to your local environment and running `npm i`, you can run tests with the following:
83+
84+
```sh
85+
npm run test:unit
86+
npm run test:e2e
87+
```
88+
89+
The same tests will run for any PR requested to the `main` branch, and all tests should pass before any PR is merged.
90+
91+
2. Write tests
92+
93+
All new features should be accompanied by at least one test for the new feature.
94+
95+
All bug fixes should be accompanied by a test that replicates the bug.
96+
97+
**When writing a test, check that it fails correctly before checking that it passes.**
98+
99+
## Submit Your Contribution!
100+
101+
After you've made the improvements, you can open a pull request and a member of the Dashibase team (well either SK or Alfred for now!) will work with you on the PR!
102+
103+
Did you have an issue, like a merge conflict, or don't know how to open a pull request? Check out [GitHub's pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) tutorial on how to resolve merge conflicts and other issues.
104+
105+
Once your PR has been merged, you will be proudly listed as a contributor in our [contributor chart](https://github.com/dashibase/dashibase/graphs/contributors)!

0 commit comments

Comments
 (0)