From bb551fa8acf187c94c7a0139fbc181f76a2f7378 Mon Sep 17 00:00:00 2001 From: Bhawna Anand <142158409+itsbhh@users.noreply.github.com> Date: Fri, 4 Oct 2024 09:37:50 +0530 Subject: [PATCH] Readme file and code of conduct enhancement README Changes: Navigation: Added clear navigation sections to improve usability, allowing contributors to easily locate important information. Contribution Guidelines: Enhanced the contribution section with comprehensive guidelines in Markdown format, making it easier for contributors to follow best practices. Code of Conduct: Linked the Contributor Covenant Code of Conduct to promote a healthy and inclusive community environment. Visual Enhancements: Improved the visual structure for better clarity and navigation, making the README more user-friendly. Detailed Instructions: Provided additional details on forking and contributing to the repository without altering the existing content. Code of Conduct Changes: Navigation: Added a Table of Contents for better readability and to help users quickly find relevant sections. Additional Topics: Introduced new sections such as "Handling Conflicts" and "Community Values" to emphasize respectful collaboration and open communication within the community. Clarified Enforcement: Provided clear enforcement guidelines for inappropriate behavior with stepwise consequences for violations, from warnings to permanent bans. --- CODE_OF_CONDUCT.md | 33 +++++++++++ README.md | 143 +++++++++++++++++++++++++++++++++++++++------ 2 files changed, 157 insertions(+), 19 deletions(-) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 1f0cf35..639f1bf 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -1,5 +1,21 @@ # Contributor Covenant Code of Conduct +## Table of Contents +- [Our Pledge](#our-pledge) +- [Our Standards](#our-standards) +- [Enforcement Responsibilities](#enforcement-responsibilities) +- [Scope](#scope) +- [Enforcement](#enforcement) +- [Enforcement Guidelines](#enforcement-guidelines) + - [1. Correction](#1-correction) + - [2. Warning](#2-warning) + - [3. Temporary Ban](#3-temporary-ban) + - [4. Permanent Ban](#4-permanent-ban) +- [Handling Conflicts](#handling-conflicts) +- [Community Values](#community-values) +- [Attribution](#attribution) + + ## Our Pledge We as members, contributors, and leaders pledge to make participation in our @@ -68,6 +84,7 @@ 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: @@ -112,6 +129,22 @@ individual, or aggression toward or disparagement of classes of individuals. **Consequence**: A permanent ban from any sort of public interaction within the community. + + +## Handling Conflicts + +- Approach conflicts with an open mind, seek mediation if necessary. +- Prioritize de-escalation over confrontation. +- Be respectful in disagreements, and aim for constructive outcomes. + +## Community Values + +- Encourage diverse viewpoints while maintaining respect and professionalism. +- Aim to foster collaboration and inclusivity in all interactions. +- Ensure all members feel safe, valued, and empowered to contribute. + +--- + ## Attribution This Code of Conduct is adapted from the [Contributor Covenant][homepage], diff --git a/README.md b/README.md index 1f0caf7..8bd1d82 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,34 @@ -# STATION GUIDE : YOUR PLATFORM GUIDE +# STATION GUIDE : YOUR PLATFORM GUIDE + + [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-) - - -[![All Contributors](https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-) + Typing SVG -welcome to repository of Station Guide +Welcome to repository of Station Guide - To get to know about Station Guide Check : - [StationGuide.md](https://github.com/dhairyagothi/StationGuide/blob/f2d4795cf3d3c57ffafb6ce007f47173d7010b1e/StationGuide.md) + - To check UI Prototype Figma design :- [StationGuideFigma.md](https://github.com/dhairyagothi/StationGuide/blob/f2d4795cf3d3c57ffafb6ce007f47173d7010b1e/StationGuideFigma.md) -# Using Station Guide +## Table of Content + +- **[Using Station Guide](#using-station-guide)** +- **[Getting Started](#getting-started)** +- **[Project Structure](#project-structure)** +- **[How to Contribute](#how-to-contribute)** +- **[Code of Conduct](#code-of-conduct)** +- **[How to Fork](#how-to-fork)** +- **[Contributors](#contributors)** +- **[Contact Information](#contact-information)** + +## Using Station Guide This project utilizes React for the frontend and Express for the backend, providing a robust foundation for your web application development. -## Prerequisites +### Prerequisites To get started, you'll need the following: @@ -25,15 +37,12 @@ To get started, you'll need the following: ## Getting Started - ### 1. Clone the Repository - **Understanding Cloning:** Cloning creates a local copy of the project on your computer, allowing you to work on it independently. This local copy is a mirror image of the original repository on GitHub or similar platforms. - Use Git to clone this repository into your local development environment: ```bash @@ -45,39 +54,42 @@ You will see this interface in your system : ![image](https://github.com/user-attachments/assets/20961ae0-2d63-45e7-9aa4-9adc01fcc4d0) +### 2. Running the Development Server - -### 3. Running the Development Server - -## Frontend: +#### Frontend: - Open a terminal or command prompt window. - Navigate to the frontend directory: + ```Bash cd frontend ``` + - Start the frontend development server : + ```Bash npm run dev ``` This will typically launch the React application on http://localhost:3000 (or the specified port) in your browser. -## Backend: +#### Backend: - Open another terminal or command prompt window (separate from the frontend window). - Navigate to the backend directory: + ```Bash cd backend ``` Start the backend development server (typically using nodemon server.js or a similar command): + ```Bash npm run start ``` +## Project Structure -### Project Structure ``` StationGuide/ ├── frontend/ @@ -97,12 +109,99 @@ StationGuide/ └── ... # Other project configuration files (e.g., .gitignore) ``` +## How to Contribute + +Contributions are always welcome! +To ensure a smooth collaboration process, Follow these steps: + + +1. **Fork the Repository:** + + - Click the "Fork" button on the top right of the repository page. This creates a copy of the repository under your GitHub account. + +2. **Clone Your Fork:** + + - Run the following command in your terminal: + ```bash + git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git + ``` + - This command downloads your fork to your local machine. + +3. **Create a Branch:** + + - Navigate into the cloned repository: + ```bash + cd Awesome-Github-Profiles + ``` + - Create a new branch for your feature or fix: + ```bash + git checkout -b your-feature-branch + ``` +4. **Make Your Changes:** + - Implement your changes in your local repository. Make sure your code is clean and follows the project's coding style guidelines. -## Contributors ✨ +5. **Test Your Changes:** -Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)): + - If applicable, run tests to ensure that your changes do not break existing functionality. + +6. **Commit Your Changes:** + + - Commit your changes with a clear and descriptive message: + ```bash + git commit -m "Add a feature or fix a bug" + ``` + +7. **Push to Your Fork:** + + - Push your changes back to your forked repository: + ```bash + git push origin your-feature-branch + ``` + +8. **Create a Pull Request:** + - Navigate to the original repository where you want to propose your changes. + - Click on "New Pull Request" and follow the instructions to submit your changes for review. + +Please refer to the detailed [contribution guidelines](CONTRIBUTING.md) for more information. + +## Code of Conduct + +To foster a positive and inclusive community, please adhere to the following guidelines: + +- **Be Respectful:** Treat everyone with respect. Engage in constructive conversations. +- **No Harassment:** Harassment, bullying, or discrimination will not be tolerated. +- **Report Issues:** If you witness or experience any unacceptable behavior, please report it to the project maintainers. + +Please read the [code of Conduct](CODE_OF_CONDUCT.md) for more clear understanding. + +## How to Fork + +Forking allows you to create a personal copy of the repository, where you can experiment and make changes without affecting the original project. Here’s how to do it: + +### Navigate to the Repository: + +- Go to the Awesome GitHub Profiles repository. + +### Click on Fork: + +- On the top right corner, click the "Fork" button. + +### Select Your Account: + +- Choose your GitHub account to create the fork. + +### Clone Your Fork: + +- Use the command below to clone your fork to your local machine: + ```bash + git clone https://github.com/YOUR_USERNAME/Awesome-Github-Profiles.git + ``` + +## Contributors + +Thanks goes to these wonderful people ( [emoji key](https://allcontributors.org/docs/en/emoji-key) ): @@ -132,4 +231,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! + +## Contact Information + +If you have questions, suggestions, or feedback, please reach out via email at email@example.com. You can also join our discussion forum [here](https://github.com/dhairyagothi/StationGuide/discussions). + +We value open communication and are happy to help!