Skip to content

Latest commit

 

History

History
95 lines (66 loc) · 3.97 KB

Contributing.md

File metadata and controls

95 lines (66 loc) · 3.97 KB
Raw

Contributing to Dive to Dev - Hacktoberfest 2023

Thank you for considering contributing to Dive to Dev! Your contributions help make this repository a valuable resource for the web development community.

Please take a moment to review the following guidelines before making contributions:

Maintainers

Reporting Bugs

If you find a bug in the website, please help us by opening an issue with the following label:

  • Bug: Use this label if you've found a bug or an issue with the website's functionality. Please provide a detailed description of the problem, including steps to reproduce it.

Adding New Features

If you have ideas for new features or enhancements to the website, please open an issue with the following label:

  • Enhancement: Use this label to propose new features or improvements to the website. Describe the feature or enhancement you'd like to see and why it would be beneficial.

Adding Your Web Development Project

We welcome contributions of web development projects to Dive to Dev. To add your project, follow these steps:

  1. Copy the HTML snippet below and paste it as a follow-up comment in the index.html file. Be sure to include the necessary information and make the changes mentioned in the comments within the HTML.
<!--Copy content here-->
<div class="col-md-3">
  <!-- Card content here -->
  <div class="card mb-4 custom-card" id="amazon" style="width: 18rem">
    <img
      class="card-img-top"
      src="./images/project-images/Amazon-Clone.png"
      alt="Card image cap"
    />
    <!--Add your project image-->

    <div class="card-body text-center card-1">
      <h5 class="card-title">
        Amazon Landing Page
        <!--Card title/Project NAME-->
      </h5>
      <p class="card-text">
        <!--Project Description [SHORT]-->
        This a beginner friendly Amazon clone project made with HTML5 and
        CSS3🚀.
      </p>

      <a
        href="https://github.com/Manishak798/Amazon-clone"
        class="btn btn-primary"
        rel="your github project link"
      >
        Project Link<!--Go somewhere, Mention the project link--></a
      >
    </div>
  </div>
</div>

<!--copy till here-->
  1. Fill in the details within the HTML snippet in the index.html file:
  • Replace "Your Project Title Here" with the title of your project.
  • Replace "Your Project Description Here" with a brief description of your project.
  • Replace "Link to Your Project" with the link to your project's GitHub repository or live demo.
  • Add your project screenshot image to the project-images folder and provide its path in the HTML snippet.
  • Make sure you add your name and profile in the contributors.md file after making your contribution.

  1. Commit your changes with clear and concise commit messages.

  2. Push your changes to your forked repository.

  3. Create a Pull Request (PR) to the main repository's main branch. Please provide a clear and descriptive title and description for your PR. Reference any related issues in the description.

Code Review

A maintainer will review your PR, provide feedback, and may request changes. Please be responsive to any comments or feedback during the review process.

Contribution Guidelines

  • Ensure that your code is well-documented, and add comments as necessary.
  • Follow the project's coding style and conventions.
  • Do not include any unnecessary or unrelated changes in your PR.
  • Be respectful and considerate when participating in discussions and addressing feedback.

Thank You

Once you've added your project as a comment in the index.html file, a maintainer will review it. If everything looks good, it will be added to the Dive to Dev website.

Thank you for contributing to Dive to Dev - Hacktoberfest 2023! Your contributions are greatly appreciated and help make this community thrive 🎉🚀❤️.