Skip to content

Latest commit

 

History

History
65 lines (41 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

65 lines (41 loc) · 2.85 KB
Raw

Contributing Guide

Introduction

Thank you for considering to contribute to my portfolio project! Your contributions are greatly appreciated and help make the project better for everyone. This guide will outline the process for making contributions, whether it's through changes in GitHub or by forking the project and submitting a pull request.

Ways to Contribute

There are two ways to contribute to this project:

  1. Making changes directly in the GitHub/VSCode browser editor.
  2. Forking the project to your own account, cloning the repository, and submitting a pull request.

Making Changes Directly in GitHub/VSCode

If you prefer to make changes directly in GitHub or the VSCode browser editor, simply navigate to the file you want to change and click the "Edit" button. This will open up the file in the VSCode browser editor, where you can make changes, preview them, and then submit them directly to the repository.

Please follow these guidelines when making changes:

  • Ensure that your changes are in line with the project's overall style and direction.
  • Test your changes thoroughly to make sure that they don't break anything.
  • Keep your changes as small and focused as possible, making only the changes necessary to address the issue or add the feature you're working on.

Forking the Project and Submitting a Pull Request

If you prefer to fork the project and make changes locally, here are the steps to follow:

  1. Fork the repository by clicking the "Fork" button in GitHub.
  2. Clone the repository to your local machine using the following command:
git clone https://github.com/kunalkeshan/kunalkeshan.dev.git
  1. Create a new branch for your changes using the following command:
git checkout -b <branch-name>
  1. Make the changes you wish to contribute to the project.
  2. Commit your changes to your local branch using the following command:
git commit -m "Descriptive message about your changes"
  1. Push your changes to your forked repository using the following command:
git push origin <branch-name>
  1. Go to the original repository in GitHub and create a pull request, comparing your branch with the main branch of the repository.

Please follow these guidelines when making changes:

  • Ensure that your changes are in line with the project's overall style and direction.
  • Test your changes thoroughly to make sure that they don't break anything.
  • Keep your changes as small and focused as possible, making only the changes necessary to address the issue or add the feature you're working on.
  • Write clear and descriptive commit messages to help others understand what you've changed.

Conclusion

Thank you again for considering to contribute to my portfolio project! I appreciate your help in making it better for everyone. If you have any questions or need clarification on anything, don't hesitate to ask.