diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c44e7a2..1cd44e9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,25 +1,89 @@ -## Fork this repository + **# Contributing to First Contributions Web App** -Fork this repo by clicking on the fork button on the top of this page. -This will create a copy of this repository in your account. +**Thank you for your interest in contributing to the First Contributions web app!** -## Clone the repository -Now clone the forked repository to your machine. Go to your GitHub account, open the forked repo, click on the clone button and then click the *copy to clipboard* icon. +We welcome contributions of all kinds, from code to documentation to design. Here's a guide to get you started: -Open a terminal and run the following git command: +**1. Fork the Repository** +- Click the "Fork" button in the top right corner of the GitHub repository page. This creates a copy of the repository in your own GitHub account. + +**2. Clone the Repository** + +- Open a terminal and run the following command to clone your forked repository to your local machine: + +```bash +git clone https://github.com//firstcontributions.github.io.git ``` -git clone "url you just copied (url of the forked repo)" + +- Replace `` with your actual GitHub username. + +**3. Create a Branch** + +- Navigate to the cloned repository directory: + +```bash +cd firstcontributions.github.io +``` + +- Create a new branch for your changes: + +```bash +git checkout -b +``` + +- Replace `` with a descriptive name for your changes. + +**4. Make Your Changes** + +- Make your desired changes to the code, documentation, or design. +- Follow the project's coding style and conventions. +- Write clear and concise code comments. + +**5. Commit Your Changes** + +- Add the changed files to the staging area: + +```bash +git add ... ``` -where "url you just copied" (without the quote marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url. +- Commit your changes with a descriptive message: -For example: +```bash +git commit -m "Description of your changes" ``` -git clone https://github.com//firstcontributions.github.io.git + +**6. Push Your Changes** + +- Push your branch to your forked repository on GitHub: + +```bash +git push origin ``` -where `` is your GitHub username. -Here you're copying the contents of your firstcontributions.github.io repository on GitHub to your computer. + +**7. Open a Pull Request** + +- Go to the original repository on GitHub. +- Click the "Pull Request" button. +- Select your branch as the source and `main` as the target branch. +- Provide a clear and concise description of your changes. + +**8. Await Review** + +- The repository maintainers will review your pull request and provide feedback. +- You may be asked to make additional changes or address any issues. + +**9. Merge (If Accepted)** + +- If your pull request is approved, it will be merged into the main repository. +- Your contribution will be part of the project! + +**Additional Notes:** + +- Before starting work, check for existing issues or discussions related to your idea to avoid duplication. +- If you're unsure about anything, feel free to ask questions in the issue tracker or discussions. +- We value diversity and inclusivity, so please be respectful of others in all project interactions. ## Running The Project You should have [yarn](https://yarnpkg.com/en/docs/install) and [node](https://nodejs.org/en/download/) to run the project locally. @@ -42,3 +106,5 @@ yarn start ``` Now you can open your cloned project at ` http://localhost:3000/ ` + +**Thank you for contributing!** ✨