Skip to content

Latest commit

 

History

History
95 lines (73 loc) · 3.44 KB

CONTRIBUTING.md

File metadata and controls

95 lines (73 loc) · 3.44 KB
Raw

Submission Guidelines

To successfully contribute to this repository and participate in Hacktoberfest 2024, follow these submission guidelines:

  1. Fork the Repository:

    • Click the "Fork" button at the top-right corner of this repository to create your own copy. forking

  2. Clone Your Fork:

    git clone https://github.com/your-username/hacktoberfest24.git

  3. Navigate to the Repository:

    cd hacktoberfest24

  4. Add Your Contribution:

    • Follow the instructions for your chosen theme and level.
    • Ensure your files are organized under the appropriate theme and level folders.
    • Example Directory Structure: 
      /SysCom/
  /Level0_CustomizeDesktop/
    /screenshots/
    - README.md
  /Level1_HelloDocker/
    - Dockerfile
    - README.md
/WebDev/
  ...

  5. Commit Your Changes:

    git add .
git commit -m "Add SysCom Level1: Run the standard hello world docker"

  6. Push to Your Fork:

    git push origin your-branch-name

  7. Create a Pull Request (PR):

    pull_rq

    • Navigate to your forked repository on GitHub.
    • Click "Compare & pull request."
    • Provide a clear and descriptive title and description for your PR.
    • Ensure your PR targets the correct branch of the original repository.

  8. Await Review:

    • Maintainers will review your PR. They may request changes or approve it.
    • Engage respectfully and make necessary adjustments based on feedback.

  9. Celebrate Your Contribution:

    • Once your PR is merged, you've successfully contributed to Hacktoberfest 2024!

Important: Each problem must only have one pull request. Do not club multiple solutions in a single pull request, as it will be rejected.

Repository Do's and Don'ts

Do's

  • Follow the Structure: Organize your contributions under the correct theme and level directories.
  • Read the Guidelines: Ensure you understand the requirements for each level before starting.
  • Write Clear Documentation: Include README.md files that explain your work, how to run it, and any other pertinent details.
  • Use Meaningful Commit Messages: Clearly describe what changes you've made.
  • Respect Licensing: Ensure your contributions comply with the repository’s licensing terms.
  • Engage Positively: Communicate respectfully with maintainers and other contributors.

Don'ts

  • Don't Duplicate Efforts: Check if a similar contribution already exists to avoid redundancy.
  • Don't Submit Incomplete Work: Ensure your contribution meets the level’s requirements before submitting.
  • Avoid Large Binary Files: Use appropriate formats and avoid uploading unnecessary large files.
  • Don't Ignore Feedback: If maintainers request changes, address them promptly and courteously.
  • Avoid Offensive Content: Ensure your submissions are professional and respectful.
  • No Plagiarism: Ensure all your work is original and properly attribute any sources or inspirations.

Resources

General