-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
73 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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**. |