Skip to content

Commit 72da5ac

Browse files
authored
Create CONTRIBUTING.md
1 parent 9456e3e commit 72da5ac

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

CONTRIBUTING.md

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via an issue,
4+
with the owners of this repository before making a change. You can open an issue [here](https://github.com/Codebrahma/react-lite-ui/issues).
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure that all external dependencies not required for the build / development flow are removed
11+
before build.
12+
2. Update the documentation for the component ( if applicable ).
13+
3. Ensure all tests are passing and are above the coverage threshold.
14+
4. Your Pull Request can be merged in once you have the sign-off of atleast one other developer. If you find that your
15+
Pull Request has been approved and not been merged, you can ask the reviewer to merge it. Incase there has been no activity
16+
on your pull request :
17+
* Ensure there is an issue open which is related to the request. Pull requests without any related issues will not be processed.
18+
* Check for activity in other issues / pull requests related to your pull request.
19+
20+
## Code of Conduct
21+
22+
Our team is dedicated towards creating and maintaining an ethical, responsible and positive environment for the community.
23+
Please go through [this document]() to read about **some** of the ways in which we can maintain proper communication.
24+
25+
## Getting Started
26+
27+
To run the project locally, you can :
28+
29+
1. Clone the repository :
30+
31+
via SSH :
32+
```
33+
git clone git@github.com:Codebrahma/react-lite-ui.git
34+
```
35+
36+
**or**
37+
38+
via HTTPS:
39+
```
40+
git clone https://github.com/Codebrahma/react-lite-ui.git
41+
```
42+
43+
2. Install dependencies from `package.json` :
44+
45+
```
46+
npm install && cd doc && npm install
47+
```
48+
49+
50+
3. To run the documentation page in your local server :
51+
```
52+
npm run docs:dev
53+
```
54+
55+
**Note :** If you are willing to contribute to the project, then you can fork the repository and raise a Pull Request from
56+
the fork.
57+
58+
### Adding features / functionalities :
59+
60+
If you want to add a new feature to the existing set of functionalities, we recommend you to
61+
first discuss with the repository maintainers by opening an issue [here](https://github.com/Codebrahma/react-lite-ui/issues).
62+
Please note that we may add a suggested feature only if it adds value to our [vision] of this project.
63+
64+
#### Notes on adding new functionalities :
65+
66+
After adding a new feature, please go through the following :
67+
68+
1. Proper tests for the new features have been added and are passing.
69+
2. All the tests should pass.
70+
3. Documentation has been updated with new features and instructions of their usage.
71+
72+
### Our Responsibilities
73+
74+
Project maintainers are responsible for clarifying the standards of acceptable
75+
behavior and are expected to take appropriate and fair corrective action in
76+
response to any instances of unacceptable behavior.
77+
78+
Project maintainers have the right and responsibility to remove, edit, or
79+
reject comments, commits, code, wiki edits, issues, and other contributions
80+
that are not aligned to this Code of Conduct, or to ban temporarily or
81+
permanently any contributor for other behaviors that they deem inappropriate,
82+
threatening, offensive, or harmful.
83+
84+
### Scope
85+
86+
This Code of Conduct applies both within project spaces and in public spaces
87+
when an individual is representing the project or its community. Examples of
88+
representing a project or community include using an official project e-mail
89+
address, posting via an official social media account, or acting as an appointed
90+
representative at an online or offline event. Representation of a project may be
91+
further defined and clarified by project maintainers.

0 commit comments

Comments
 (0)