Hello everyone! This is a React website developed for the IITG Cyber Security Module. We welcome and appreciate your contributions to this project. Below are the steps to contribute:
-
Fork the Repository: Start by forking this repository to your GitHub account. This will create a copy of the project under your account, allowing you to freely make changes without affecting the original repository.
-
Clone the Repository: Clone the forked repository from your GitHub repository list to your local machine using the
git clonecommand.git clone https://github.com/your-username/repository-name.git
-
Create a New Branch: Once cloned, create a new branch to work on your changes. This helps in keeping the main codebase clean and allows for better organization. Use the following command to create a new branch:
git checkout -b <branch-name>
-
Install Dependencies: Navigate to the cloned repository on your desktop and install the project dependencies using npm.
npm install
You need not worry about the
.gitignorefile; it's already included in the repository. Thus, dependencies won't be pushed along with your changes. -
Start Development Server: Open the development environment by running the following command:
npm start
-
Make Changes: Make the necessary changes to the codebase to fix bugs or add new features.
-
Commit Changes: Once you've made your changes, commit them to your branch with a descriptive commit message.
git add . git commit -m "Your descriptive commit message"
-
Push Changes: Push your changes to your forked repository on GitHub.
git push origin <branch-name>
-
Create a Pull Request: Finally, navigate to your forked repository on GitHub, switch to the branch you've just pushed, and create a pull request. Wait for it to be reviewed and merged into the master branch.
Thank you for considering contributing to our project. We appreciate your efforts and look forward to your contributions. Happy coding! 😊