Skip to content

Latest commit

 

History

History
70 lines (48 loc) · 3.98 KB

CONTRIBUTING.md

File metadata and controls

70 lines (48 loc) · 3.98 KB
Raw

Welcome to Its-webtober!

I am thrilled to have you join our open-source community. By contributing, you'll not only sharpen your skills but also make a positive impact on our projects. Let's get started!

Code of Conduct

Before you start, please familiarize yourself with our Code of Conduct. We expect all contributors to adhere to these guidelines to foster a positive and inclusive environment.

How to Contribute

  1. Fork the Repository: To get started, fork the repository to contribute to on GitHub. You can do this by clicking the "Fork" button.

  2. Clone the Repository: Clone the forked repository to your local development environment. This will create a local copy of the project where you can make your changes.

    git clone https://github.com/<your-username>/<repository-name>.git
cd <repository-name>

  3. Contributing Your Project: There are two ways to contribute:

    1. New Project: If you're creating a new project for this initiative, follow these steps:

      • Create a new branch: In your local copy of the repository, create a new branch to work on your project. 
        git checkout -b <your-project-name>
      • Develop your project: Create a new folder with your project name and add all of your project files and folders inside it, ensuring you include a README.md file explaining your project's purpose and functionality.
      • README.md content:
        • Briefly describe your project and tech stack.
        • Include installation and usage instructions.
        • Consider adding screenshots or examples.
        • Provide a link to your GitHub account (optional).

    2. Contributing to an Existing Project: If you're improving an existing project, follow these steps:

      • Find an issue: Look through the open issues in the repository to find a task or bug you'd like to work on.
      • Claim the issue (optional): If you plan to work on the issue, let others know by leaving a comment.
      • Make your changes: Fix the bug or complete the task, following the project's coding style and guidelines.

  4. Commit Your Changes: Use a clear and concise commit message that accurately describes the changes you've made

    git commit -m "<Add your concise commit message>"

  5. Push Your Changes: Push your changes to your forked repository on GitHub

    git push origin <your-project-name>

  6. Submit a Pull Request:

    • Open a pull request: Navigate to your forked repository on GitHub and click the "Pull Request" button.
    • Provide a clear description: Explain the changes you've made and why they're beneficial.
    • Reference related issues or discussions: If applicable, link to any relevant issues or discussions.
    • Follow the template: Follow the project Pull Request Template

  7. Review: Be prepared to participate in code reviews. If maintainer provide feedback or suggestions, be open to making necessary changes to your pull request.

  8. Merge: Once your pull request is approved, it will be merged into the main repository. Congratulations! Your contribution is now a valuable part of Its-webtober.

Reporting Issues

If you encounter a bug, have a suggestion, or want to discuss something related to the project, please check the Issues section. If you can't find an existing issue that addresses your concern, feel free to open a new one.

Thank You

Thank you for contributing to Its-webtober! Your efforts are invaluable. Your contributions help improve our projects and strengthen our community.

If you have any questions or need further assistance, please don't hesitate to reach out to us at Its Hacktober WhatsApp Group

"Coding is not about getting to the finish line; it's about enjoying the journey." - Unknown Coder