Skip to content

Commit c6bfa69

Browse files
committed
[REF]: improve comunity checklist for github
1 parent 078a585 commit c6bfa69

File tree

2 files changed

+162
-0
lines changed

2 files changed

+162
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, 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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
- Using welcoming and inclusive language
12+
- Being respectful of differing viewpoints and experiences
13+
- Gracefully accepting constructive criticism
14+
- Focusing on what is best for the community
15+
- Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
- The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
- Trolling, insulting/derogatory comments, and personal or political attacks
21+
- Public or private harassment
22+
- Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
- Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
28+
29+
Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
## Scope
32+
33+
This Code of Conduct applies within all project spaces, and it also applies when an individual is representing the project or its community in public spaces. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
34+
35+
## Enforcement
36+
37+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at contact@mui.com. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
38+
39+
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org), version 1.4,
44+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
45+
46+
For answers to common questions about this code of conduct, see
47+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Contributing to Dropzone-ui
2+
3+
If you're reading this, you're awesome! Thank you for helping us make this project great and being a part of the dropzone-ui community. Here are a few guidelines that will help you along the way.
4+
5+
## Code of Conduct
6+
7+
Dropzone-ui has adopted the [Contributor Covenant](https://www.contributor-covenant.org/) as its Code of Conduct, and we expect project participants to adhere to it.
8+
Please read [the full text](/CODE_OF_CONDUCT.md) so that you can understand what actions will and will not be tolerated.
9+
10+
## Your first Pull Request
11+
12+
Working on your first Pull Request? You can learn how from this free video series:
13+
14+
[How to Contribute to an Open Source Project on GitHub](https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github)
15+
16+
If you decide to fix an issue, please be sure to check the comment thread in case somebody is already working on a fix. If nobody is working on it at the moment, please leave a comment stating that you have started to work on it so other people don't accidentally duplicate your effort.
17+
18+
If somebody claims an issue but doesn't follow up for more than a week, it's fine to take it over but you should still leave a comment.
19+
If there has been no activity on the issue for 7 to 14 days, it is safe to assume that nobody is working on it.
20+
21+
## Sending a Pull Request
22+
23+
Dropzone UI is a community project, so Pull Requests are always welcome, but, before working on a large change, it is best to open an issue first to discuss it with the maintainers.
24+
25+
However, as it happen in the past, there could be small fixes than can be directly posted on a pull request.
26+
27+
When in doubt, keep your Pull Requests small. To give a Pull Request the best chance of getting accepted, don't bundle more than one feature or bug fix per Pull Request. It's often best to create two smaller Pull Requests than one big one.
28+
29+
1. Fork the repository.
30+
31+
2. Clone the fork to your local machine and add upstream remote:
32+
33+
```sh
34+
git clone https://github.com/<your username>/react.git
35+
cd react
36+
git remote add upstream https://github.com/dropzone-ui/react.git
37+
```
38+
39+
<!-- #default-branch-switch -->
40+
41+
3. Synchronize your local `master` branch with the upstream one:
42+
43+
```sh
44+
git checkout master
45+
git pull upstream master
46+
```
47+
48+
4. Install the dependencies with npm:
49+
50+
```sh
51+
npm install
52+
```
53+
54+
5. Create a new topic branch:
55+
56+
```sh
57+
git checkout -b my-topic-branch
58+
```
59+
60+
6. Make changes, commit and push to your fork:
61+
62+
```sh
63+
git push -u origin HEAD
64+
```
65+
66+
7. Go to [the repository](https://github.com/dropzone-ui/react) and make a Pull Request.
67+
68+
The core team is monitoring for Pull Requests. We will review your Pull Request and either merge it, request changes to it, or close it with an explanation.
69+
70+
## Commit Convention
71+
72+
In order to make it easy to review the previous commits and understand the "what"s and "why"s behind each change, the following commit pattern is used:
73+
74+
- To make descriptive commits the command `git commit -v` is used.
75+
- Otherwhise, `git commit -m "[<type>]: <message>"` command can be used when the commit message is not long enought to give it a body.
76+
77+
```
78+
[<type>]: <subject>
79+
<BLANK_LINE>
80+
<body> (optional)
81+
```
82+
83+
The definition for each commit section is as follows:
84+
85+
`<type>`: A short label of the type of change.
86+
87+
- It can be any of the following:
88+
- FEAT: A new feature
89+
- FIX: Bug fix
90+
- DOCS: Documentation changes
91+
- STYLE: Formatting, missing spaces, etc
92+
- REFACTOR: Code that it's neither a feat nor a fix
93+
94+
`<subject>`: It is a short description of the commit
95+
96+
- In general, no more than 80 characters
97+
- Written in present tense
98+
- Starts with capital letter
99+
100+
`<body>`: The long description of the commit
101+
102+
- Explains why the commit is needed
103+
- Briefly explains what the commit does
104+
- Talks about the related test cases and docs
105+
- In general, no more than 80 characters per line
106+
107+
## Coding style
108+
109+
Please follow the coding style of the project. Dropzone ui uses prettier and eslint, so if possible, enable linting in your editor to get real-time feedback.
110+
111+
Finally, when you submit a Pull Request, they are run again by our continuous integration tools, but hopefully, your code is already clean!
112+
113+
## License
114+
115+
By contributing your code to the [dropzone-ui/react](https://github.com/dropzone-ui/react) GitHub repository, you agree to license your contribution under the [MIT license](/LICENSE).

0 commit comments

Comments
 (0)