Skip to content

Latest commit

 

History

History
120 lines (79 loc) · 5.91 KB

CONTRIBUTING.md

File metadata and controls

120 lines (79 loc) · 5.91 KB
Raw

Contributing to the GDSC Official Website

Welcome to the GDSC (Google Developer Student Clubs) Official Website repository! We're excited that you're interested in contributing to our project. Whether you're a beginner or an experienced developer, there are many ways you can help improve our website. All types of contributions are encouraged and valued. Please make sure to read this README before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your Linkedin posts
  • Mention the project at local meetups and tell your friends/colleagues

Getting Started

Follow the steps below to get started with contributing to GDSC AEC Official Website.

1. Fork the Repository

  • Click the "Fork" button at the top-right corner of the repository page. This action will create a copy (fork) of the GDSC AEC India Official Website repository in your GitHub account.

2. Clone Your Fork

  • After forking, you'll need to clone your forked repository to your local machine using the following command:

    git clone https://github.com/your-username/gdsc-aec-web

  • Replace your-username with your GitHub username.

4. RUN the following command on your terminal

 npm i
 npm start

3. Explore the Codebase

  • Take some time to explore the project's codebase. You can do this by navigating through the files and directories in the cloned repository.

4. Check the Issues

  • Visit the GitHub Issues page of the repository.
  • Look for issues that interest you or match your skill level. If you're new to open source or web development, search for issues labeled as "beginner-friendly" or "Hacktoberfest" to find tasks suitable for beginners.

5. Create a New Branch

  • Before making changes, it's essential to create a new branch dedicated to your work. Use the following command to create a new branch with a descriptive name:

    git checkout -b feature/your-feature-name

  • Absolutely, it's important to note that the feature/your-feature-name branch naming convention is just a commonly used practice. Here's an updated version of the step with that clarification:

5. Create a New Branch

  • Before making changes, it's essential to create a new branch dedicated to your work. Use the following command to create a new branch with a descriptive name:

    git checkout -b feature/your-feature-name

  • Replace feature/your-feature-name with a short, meaningful name that describes the changes you plan to make. This naming convention is a common practice, but you can choose a different name if it makes more sense for your specific contribution.

6. Make Changes

  • Write your code, fix bugs, or add new features to the GDSC AEC India Official Website. You can use your preferred code editor for this.

7. Test Your Changes

  • Ensure that your changes work as expected by testing them locally. You can open the HTML file in a web browser to preview the changes.

8. Commit Your Changes

  • Once you're satisfied with your work, you need to stage your changes and then commit them. First, add the changes to the staging area using the following command:

    git add .

  • This command stages all changes in your working directory for the next commit.

  • After adding your changes, commit them with a descriptive commit message using the following command:

    git commit -m "Add a descriptive commit message here"

  • Provide a clear and concise commit message that explains what your changes do.

  • Your changes are now committed and ready to be pushed to your forked repository.

9. Push Your Changes

  • Push your committed changes to your forked repository on GitHub using the following command:

    git push origin feature/your-feature-name

10. Open a Pull Request

  • Finally, go to the Pull Requests tab of the original repository (GDSC AEC India Official Website).
  • Click the "New Pull Request" button to open a new pull request.
  • In the pull request description, provide details about the changes you made and why they are valuable. Make sure the checklist is completed.
  • Our team will review your pull request, offer feedback if needed, and merge it into the main project if everything looks good.

Code Style and Guidelines

Please adhere to the following guidelines when contributing:

  • Write clean and well-documented code.
  • Follow the existing coding style used in the project.
  • Test your changes thoroughly to avoid introducing bugs.

Getting Help

If you have questions or need assistance, don't hesitate to reach out. You can:

  • Join our Discord community and ask for help in the #hacktoberfest-23 channel.
  • Comment on the relevant GitHub issue if you have questions about a specific task.

Hacktoberfest Guidelines

To be eligible for Hacktoberfest swags, please make sure to:

  • Make at least four valid pull requests during the month of October.
  • Follow our Hacktoberfest Code of Conduct.
  • Label your pull requests with "hacktoberfest" to help the maintainers make them count towards your participation.

Thank You!

We appreciate your contribution to the GDSC Official Website. Your help makes a difference in our community. Happy coding, and welcome to the team!