From 800780ebef967f7c205b8a12c8e8a640291724fb Mon Sep 17 00:00:00 2001 From: Dipen Patel <107390824+DOodle25@users.noreply.github.com> Date: Wed, 13 Nov 2024 21:06:42 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e5a1c29 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,73 @@ +# Contributing to Portfolio Website - Dipen Patel + +Thank you for your interest in contributing to my personal portfolio website! Contributions are always welcome. Whether you're fixing a bug, adding a feature, or improving documentation, your help is much appreciated. + +## How to Contribute + +### 1. Fork the Repository + +Start by forking the repository to your own GitHub account. This will create a copy of the repository under your username. + +### 2. Create a New Branch + +Once you’ve forked the repository, clone it to your local machine and create a new branch for your changes: + +```bash +git clone https://github.com/yourusername/portfolio.git +cd portfolio +git checkout -b feature-name +``` + +### 3. Make Your Changes + +Make the necessary changes, whether it’s fixing a bug, adding a feature, or improving documentation. + +### 4. Test Locally + +Run the project locally to ensure that your changes work as expected. You can start the development server with: + +```bash +npm run dev +``` + +Visit [http://localhost:3000](http://localhost:3000) to see your changes. + +### 5. Commit Your Changes + +Once you're satisfied with your changes, commit them to your branch: + +```bash +git add . +git commit -m "Brief description of the changes" +``` + +### 6. Push Your Changes + +Push your changes to your forked repository: + +```bash +git push origin feature-name +``` + +### 7. Create a Pull Request + +Finally, create a pull request (PR) to merge your changes into the main repository. Provide a clear description of what changes you’ve made and why. + +## Pull Request Guidelines + +- **Write clear commit messages** that explain the purpose of the changes. +- **Keep your changes focused** on one feature or fix at a time. +- **Update documentation** if your changes affect how the project works or if you add new features. +- **Ensure your code follows the project's style** guidelines, such as consistent indentation and naming conventions. + +## Reporting Bugs or Issues + +If you find any bugs or have suggestions for improvements, please feel free to open an issue in the [Issues section](https://github.com/yourusername/portfolio/issues) of this repository. + +## Code of Conduct + +By participating in this project, you agree to follow the [Code of Conduct](CODE_OF_CONDUCT.md) to ensure that the environment remains welcoming, respectful, and inclusive for everyone. + +## License + +By contributing to this project, you agree that your contributions will be licensed under the **MIT License**.