Skip to content

Commit 4c5491f

Browse files
azriel-stephenazriel-stephen
committed
docs: improved CONTRIBUTING.md and added Code of Conduct
1 parent 4bdda7d commit 4c5491f

File tree

2 files changed

+188
-59
lines changed

2 files changed

+188
-59
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+
.
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: 60 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,31 @@
11
# Contributing to Review App API
22

33
Thank you for your interest in contributing to the Review App API!
4-
We appreciate your support and welcome your contributions to help
5-
enhance and improve the project. Please read through the following
4+
We appreciate your support and welcome your contributions to help
5+
enhance and improve the project. Please read through the following
66
guidelines to get started.
77

88
## Table of Contents
9+
910
- [Contributing to Review App API](#contributing-to-review-app-api)
1011
- [Table of Contents](#table-of-contents)
1112
- [Prerequisites](#prerequisites)
1213
- [Contributing Guidelines](#contributing-guidelines)
1314
- [Setting Up the Development Environment](#setting-up-the-development-environment)
1415
- [Submitting a Pull Request (PR)](#submitting-a-pull-request-pr)
15-
- [`.env Configuration`](#env-configuration)
16-
- [Process](#process)
16+
- [.env Configuration](#env-configuration)
17+
- [Frontend Reference Link](#frontend-reference-link)
1718
- [Code of Conduct](#code-of-conduct)
18-
- [We appreciate your contributions and look forward to
19-
collaborating with you to improve the Review App API!]
20-
(#we-appreciate-your-contributions-and-look-forward-to-collaborating-with-you-to-improve-the-review-app-api)
19+
- [We Appreciate Your Contributions!](#we-appreciate-your-contributions)
2120

2221
## Prerequisites
2322

24-
Before you begin contributing to the backend of the Review App,
25-
please ensure you have the following prerequisites installed and
26-
configured on your local machine:
23+
Before diving into contributions for the Review App backend, make sure your local machine is equipped with the following prerequisites:
2724

28-
- Docker: To set up and manage the development environment.
29-
- Git: To clone and manage the project repository.
30-
- Node.js and npm: To install project dependencies.
31-
- Yarn: To manage Node.js packages effectively.
25+
- **Docker:** Required for setting up and managing the development environment.
26+
- **Git:** Essential for cloning and managing the project repository.
27+
- **Node.js and npm:** Needed for installing project dependencies.
28+
- **Yarn:** Recommended for efficient management of Node.js packages.
3229

3330
## Contributing Guidelines
3431

@@ -41,99 +38,103 @@ We follow these guidelines for contributing:
4138
```bash
4239
git clone https://github.com/yourusername/review-app-api.git
4340

41+
```
42+
4443
3. Navigate to the backend project directory:
45-
```bash
44+
45+
```bash
4646
cd review-app-api
4747

48+
```
49+
4850
4. Create a new branch for your contribution:
51+
4952
```bash
5053
git checkout -b feature-name
5154

55+
```
56+
5257
5. Make your changes and ensure your code follows our coding
5358
standards and practices.
5459

5560
6. Test your changes locally to ensure they work as expected.
5661

5762
7. Commit your changes with clear and concise commit messages:
63+
5864
```bash
5965
git commit -m "Add feature: your feature description"
6066

67+
```
68+
6169
8. Create a pull request (PR) to the `main` repository's `main` branch.
6270

6371
## Setting Up the Development Environment
72+
6473
To set up the development environment locally, follow these steps:
6574

6675
1. Clone the backend repository:
6776
```bash
68-
git clone https://github.com/yourusername/review-app-api.git cd review-app-api
69-
77+
git clone https://github.com/yourusername/review-app-api.git
78+
cd review-app-api
79+
```
7080
2. Run Docker Compose to set up the development environment:
7181
```bash
7282
docker-compose up -d
73-
83+
```
7484
3. Install project dependencies using Yarn:
7585
```bash
7686
yarn
77-
87+
```
7888
4. Copy the `.env.example` file to .`env.local` and configure the
7989
5. following environment variables in the `.env.local` file:
90+
8091
```env
8192
DATABASE_URL=postgresql://postgres:password@localhost:5432/review
8293
JWT_SECRET=superman123
94+
You can replace `superman123` with any secret key of your choice.
8395
84-
You can replace superman123 with any secret of your choice.
96+
```
8597

86-
5. Run database migrations to set up the database:
98+
6. Run database migrations to set up the database:
8799
```bash
88100
yarn migrate:latest
89-
90-
6. Start the local development server:
101+
```
102+
7. Start the local development server:
91103
```bash
92104
yarn local
93-
94-
7. The backend will be up and running on port 8000.
105+
```
106+
8. The backend will be up and running on port 8000.
95107

96108
## Submitting a Pull Request (PR)
97109

98110
When you're ready to submit your changes, create a pull request
99-
(PR) to the `main` repository's main branch following our guidelines.
100-
Be sure to provide a clear description of your changes in the PR, and
111+
(PR) to the `main` repository's main branch following our guidelines.
112+
Be sure to provide a clear description of your changes in the PR, and
101113
one of our maintainers will review it.
102114

103-
## `.env Configuration`
104-
- Instructions on how to configure the environment variables for the
105-
Review App API.
106-
107-
1. You need to copy the `.env.example` file to
108-
`.env.local`
109-
110-
2. Then configure the necessary environment variables in the `.env.local`
111-
file.
112-
113-
4. In this case, the required environment variables are `DATABASE_URL` and
114-
`JWT_SECRET`.
115-
116-
6. The example shows the format for these variables and provides a placeholder
117-
value for `JWT_SECRET`.
118-
119-
8. You are instructed to replace this placeholder value with a secret of your choice.
120-
121-
### Process
122-
123-
- Copy the `.env.example` file to `.env.local` and configure the following
124-
environment variables in the `.env.local` file:
125-
```env
126-
DATABASE_URL=postgresql://postgres:password@localhost:5432/review
127-
JWT_SECRET=superman123
128-
129-
- You can replace superman123 with any secret of your choice.
115+
## .env Configuration
116+
117+
To set up environment variables for the Review App API, follow these steps:
118+
119+
1. **Copy `.env.example`:** Duplicate the `.env.example` file and name the copy `.env.local`.
120+
121+
2. **Edit `.env.local`:** Open the newly created `.env.local` file and configure the necessary environment variables. In this case, you'll need to set values for `DATABASE_URL` and `JWT_SECRET`.
122+
123+
```env
124+
DATABASE_URL=postgresql://postgres:password@localhost:5432/review
125+
JWT_SECRET=your-secret-key-here
126+
```
127+
128+
3. **Replace Placeholder(s)**: Make sure to replace the placeholder values for `DATABASE_URL` with your Database URL and `JWT_SECRET` with a secret key of your choice.
129+
130+
## Frontend Reference Link
131+
132+
You can find the reference link to the frontend of the Review App [here](https://github.com/piyushgarg-dev/review-app).
130133

131134
## Code of Conduct
132135

133-
Please be aware that we have a Code of Conduct (CODE_OF_CONDUCT.md) that all
134-
contributors are expected to follow. Please read and adhere to it throughout
135-
your contribution journey.
136+
We have established a [Code of Conduct](CODE_OF_CONDUCT.md) that all contributors are expected to follow. Please take a moment to read and adhere to it throughout your contribution journey. This code of conduct ensures a respectful and inclusive environment for everyone involved in the project.
136137

137-
## We appreciate your contributions and look forward to collaborating with you
138-
to improve the Review App API!
138+
## We Appreciate Your Contributions!
139139

140+
Thank you for considering contributing to the Review App API project. Your contributions are invaluable to us, and they play a crucial role in making this project better with each update.

0 commit comments

Comments
 (0)