Skip to content

Commit a33bf63

Browse files
authored
updated the contributions guidelines
1 parent ab98ae2 commit a33bf63

File tree

1 file changed

+40
-111
lines changed

1 file changed

+40
-111
lines changed

Contribution_Guidelines.md

Lines changed: 40 additions & 111 deletions
Original file line numberDiff line numberDiff line change
@@ -1,124 +1,53 @@
1-
# Contributor Covenant Code of Conduct
1+
# Contributing to ChatDev
22

3-
## Our Pledge
3+
Whether you're looking to raise an issue, fix a bug, or add a feature, we're thrilled you're here to improve the project. This document outlines how to become a contributor to this project.
44

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.
5+
### Table of Contents
116

12-
We pledge to act and interact in ways that contribute to an open, welcoming,
13-
diverse, inclusive, and healthy community.
7+
1. [Code of Conduct](#code-of-conduct)
8+
2. [How to Contribute](#how-to-contribute)
9+
3. [Pull Requests](#pull-requests)
10+
4. [Style Guidelines](#style-guidelines)
11+
5. [Review Process](#review-process)
1412

15-
## Our Standards
13+
### Code of Conduct
1614

17-
Examples of behavior that contributes to a positive environment for our
18-
community include:
15+
We expect all contributors to act professionally and respectfully, and we expect our social channels to be a safe and enjoyable environment for all.
1916

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
17+
### How to Contribute
2718

28-
## Examples of unacceptable behavior include:
19+
1. **Update your fork:** Before you make any changes, make sure your fork is up to date with the main branch.
20+
```bash
21+
git pull origin main
22+
```
23+
2. **Create a new branch:** Create a new branch where you'll do your work.
24+
```bash
25+
git checkout -b my-new-feature
26+
```
27+
3. **Make your changes:** Make the necessary changes to the code or documentation.
2928
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
29+
4. **Commit your changes:** Once you've made your changes, commit them.
30+
```bash
31+
git add .
32+
git commit -m "Add some feature"
33+
```
34+
5. **Push your changes:** Push the changes to your new branch on your fork.
35+
```bash
36+
git push origin my-new-feature
37+
```
38+
6. **Create a pull request:** Go to your fork on GitHub and click the 'Compare & pull request' button next to your new branch to create a new pull request.
3839

39-
## Enforcement Responsibilities
40+
### Pull Requests
4041

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.
42+
- The pull request should be related to an issue. If an issue doesn't exist for your contribution, create one.
43+
- The pull request should have a descriptive title and any necessary explanations in the comments.
44+
- Make sure your pull request is based on the latest commits to avoid conflicts.
4545
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.
46+
### Style Guidelines
5047
51-
## Scope
48+
- Adhere to the existing coding style.
49+
- Write your code in Python, ensuring it follows best practices.
5250
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
51+
### Review Process
52+
- A maintainer will review the pull request and provide feedback or merge it.
53+
- If changes are required, make them and push them to the same branch, and the pull request will automatically update.

0 commit comments

Comments
 (0)