Merge branch 'Vin205:main' into main

CODE_OF_CONDUCT.md

@@ -0,0 +1,117 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible 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.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Contact Information
+
+For any questions or further clarification, please contact admin

README.md

@@ -33,24 +33,53 @@ Make sure you have the following installed:
 - [Node.js](https://nodejs.org/en/) (v14 or above)
 - [npm](https://www.npmjs.com/get-npm)
 
-### Installation
+### Project Set Up 
 
-1. Clone the repository:
-   ```bash
-   git clone https://github.com/your-repo/enyanjyoti.git
+1. 🍴 Fork this repository. 
+
+- Click the `Fork` button at the top-right corner of this repository page to create a copy of the repository under your GitHub account.
+
+2. 📥 Clone the repository:
+```bash
+   git clone https://github.com/<your-username>/enyanjyoti.git
+   ```
+
+3. 📂 Change the working directory: 
+```bash
    cd enyanjyoti
    ```
 
-2. Install dependencies:
-   ```bash
+4. 🔗 Add a reference to the original repository.
+```bash
+   git remote add upstream https://github.com/Vin205/Enyanjyoti.git
+   ```
+
+5. 🔍 Check the remotes for this repository.
+```bash
+   git remote -v
+   ```
+
+6. ⬇️ Always take a pull from the upstream repository to your main branch to keep it up-to-date with the main project (updated repository).
+```bash
+   git pull upstream main
+   ```
+
+7. 🌿 Create a new branch. 
+```bash
+   git checkout -b <your-branch-name>
+   ```
+
+8. 🛠️ Install dependencies:
+```bash
    npm install
    ```
 
-3. Start the development server:
-   ```bash
+9. 📊 Start the development server:
+```bash
    npm start
    ```
 
+You are all set! 🎉
 The app should now be running at [http://localhost:3000](http://localhost:3000).
 
 ---
@@ -83,22 +112,49 @@ For more scripts and configurations, refer to the [official Create React App doc
 
 ## 📥 How to Contribute
 
+### 🐛 Issues
+
+Found a bug? Want to request a feature? Head over to the [Issues section](https://github.com/your-repo/issues) and let us know. Please check if the issue already exists before submitting a new one.
+
+---
+
 We welcome contributions to the Enyanjyoti platform! To get started:
 
-1. Fork the repository.
-2. Create a new branch with a descriptive name:
-   ```bash
-   git checkout -b branch_name
+1. Set up the project. (Refer to the Project set up guide for the same)
+
+2. Perform your desired changes to the code base. 
+
+3. Track your changes.
+```bash
+   git add .
    ```
-3. Make your changes and commit them:
-   ```bash
-   git commit -m "Add your detailed message here"
+
+4. Commit your changes with a relevant commit message. 
+
+```bash
+    git commit -m "Add feature X"
+   ```
+   Or if you fixed a bug, you could use:
+
+```bash
+    git commit -m "Fix issue Y"
    ```
-4. Push to your branch:
-   ```bash
+
+5. Push the commited changes in your branch to your remote repo:
+
+```bash
    git push origin main
    ```
-5. Create a pull request to the main branch.
+
+6. Create a pull request to the main branch. 
+
+- Go to your forked repository on GitHub and click on `Compare & pull request`.
+
+🎉 Voila! You have made a PR to the Enyanjyoti project. Sit back patiently and relax while the project maintainers review your PR.
+
+---
+
+Thank you for your contributions!
 
 ### Contribution Guidelines:
 - Keep code clean and well-documented.
@@ -114,12 +170,6 @@ We follow the [Contributor Covenant Code of Conduct](https://www.contributor-cov
 
 ---
 
-## 🐛 Issues
-
-Found a bug? Want to request a feature? Head over to the [Issues section](https://github.com/your-repo/issues) and let us know. Please check if the issue already exists before submitting a new one.
-
----
-
 ## 🔄 Pull Requests
 
 All contributions are made through pull requests. To submit a pull request, follow these steps: