Merge pull request #245 from Codebrahma/rishichawda-patch-1

Create CONTRIBUTING.md

Author: rishichawda

CODE_OF_CONDUCT.md

@@ -0,0 +1,30 @@
+# Code of Conduct
+
+> A code of conduct is a set of rules outlining the social norms and rules and responsibilities of, or proper practices for, an individual, party or organization
+
+## Summary
+
+Be kind and do not insult or put down others. Behave professionally. 
+
+These are the values to which people in the community should aspire:
+
+- Be friendly and welcoming
+- Be patient
+  - Remember that people have varying communication styles and that not everyone is using their native language. 
+  (Meaning and tone can be lost in translation.) 
+- Be thoughtful
+  - Productive communication requires effort. Think about how your words will be interpreted.
+  - Remember that sometimes it is best to refrain entirely from commenting. 
+- Be respectful
+  - In particular, respect differences of opinion. 
+- Be charitable
+  - Interpret the arguments of others in good faith, do not seek to disagree.
+  - When we do disagree, try to understand why. 
+- Avoid destructive behavior:
+  - Derailing: stay on topic; if you want to talk about something else, start a new conversation.
+  - Unconstructive criticism: don't merely decry the current state of affairs; offer—or at least solicit—suggestions as 
+  to how things may be improved.
+  - Snarking (pithy, unproductive, sniping comments)
+  - Discussing potentially offensive or sensitive issues; this all too often leads to unnecessary conflict.
+  - Microaggressions: brief and commonplace verbal, behavioral and environmental indignities that communicate hostile, 
+  derogatory or negative slights and insults to a person or group. 

CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via an issue, 
+with the owners of this repository before making a change. You can open an issue [here](https://github.com/Codebrahma/react-lite-ui/issues).
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure that all external dependencies not required for the build / development flow are removed
+before build.
+2. Update the documentation for the component ( if applicable ).
+3. Ensure all tests are passing and are above the coverage threshold.
+4. Your Pull Request can be merged in once you have the sign-off of atleast one other developer. If you find that your
+Pull Request has been approved and not been merged, you can ask the reviewer to merge it. Incase there has been no activity
+on your pull request : 
+    * Ensure there is an issue open which is related to the request. Pull requests without any related issues will not be processed.
+    * Check for activity in other issues / pull requests related to your pull request.
+
+## Code of Conduct
+
+Our team is dedicated towards creating and maintaining an ethical, responsible and positive environment for the community.
+Please go through our code of conduct to read about some of the ways in which we can maintain proper communication.
+
+## Getting Started
+
+To run the project locally, you can : 
+
+1. Clone the repository :
+
+via SSH :
+```
+git clone git@github.com:Codebrahma/react-lite-ui.git
+```
+
+**or**
+
+via HTTPS: 
+```
+git clone https://github.com/Codebrahma/react-lite-ui.git
+```
+
+2. Install dependencies from `package.json` : 
+
+```
+npm install && cd doc && npm install
+```
+
+
+3. To run the documentation page in your local server : 
+```
+npm run docs:dev
+```
+
+**Note :** If you are willing to contribute to the project, then you can fork the repository and raise a Pull Request from 
+the fork.
+
+### Adding features / functionalities :
+
+If you want to add a new feature to the existing set of functionalities, we recommend you to
+first discuss with the repository maintainers by opening an issue [here](https://github.com/Codebrahma/react-lite-ui/issues).
+Please note that we may add a suggested feature only if it adds value to our [purpose](#purpose-) of this project.
+
+#### Notes on adding new functionalities :
+
+After adding a new feature, please go through the following :
+
+1. Proper tests for the new features have been added and are passing.
+2. All the tests should pass.
+3. Documentation has been updated with new features and instructions of their usage.
+
+## Purpose :
+
+The purpose of this project is to provide a component library and ultimately a UI kit that is
+easier to customise, lightweight and easy to use than any other popular libraries are / have been able to provide.
+The focus is on keeping the components as minimal as possible while providing various options to
+customise which might generally be required in a scalable production code and can decrease the overhead of 
+complicated configurations, code styles or other requirements.
+
+### Our Responsibilities
+
+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.
+
+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.
+
+### Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. 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.