Skip to content

Latest commit

 

History

History
94 lines (67 loc) · 4.56 KB

CONTRIBUTION_GUIDELINES.md

File metadata and controls

94 lines (67 loc) · 4.56 KB
Raw

📜 Contribution Guidelines

We are excited to have you contribute during Hacktoberfest 2024. To ensure a smooth and enjoyable experience for everyone, please follow these guidelines:

Table of Contents

  1. Code of Conduct
  2. General Guidelines
  3. Directory Structure
  4. How Can I Contribute?
  5. Development Workflow
  6. Community Guidelines

Code of Conduct

Please read and follow our Code of Conduct. Respectful and inclusive behavior is expected from all contributors and maintainers.

💡 General Guidelines

  • Valid Contributions Only: All contributions should be meaningful and in line with the repository's purpose. Pull Requests (PRs) that do not add value—such as adding empty files, updating minor typos, or making insignificant changes—will not be accepted.
  • Maintain Code Quality: Ensure that your code is clean, well-documented, and follows the best practices of the programming language you are using. Poorly written code or submissions with errors will be marked as invalid.
  • Be Respectful and Kind: We welcome contributors of all experience levels. Please be considerate and supportive of each other. Respect the work of your fellow contributors, and engage in constructive discussions.

📁 Directory Structure

We have a structured directory system to keep the repository organized:

  • Each programming language has its own folder inside projects, such as Java, Kotlin, React Native, Python, Javascript etc.
  • If you are contributing a project or code in a new language not already present, feel free to create a new directory for it. Use the language name as the folder name, such as Go or C#.
  • Keep your projects and contributions within the relevant folder. For example, if you are contributing a Python project, place it in the Python folder.

This structure helps maintain order and ensures that future contributors can easily find and collaborate on projects.

How Can I Contribute?

🐞 Reporting Bugs

If you find a bug, please help us by submitting an issue:

  1. Search for existing issues – to make sure the bug hasn't already been reported.
  2. Create a new issue – if no similar issue exists, open a new issue and provide:
    • A clear, descriptive title.
    • Steps to reproduce the bug.
    • Your environment (browser, operating system, etc.).
    • Any relevant screenshots or error messages.

Suggesting Features

We welcome suggestions for improvements! To submit a feature request:

  1. Check for existing feature requests – to avoid duplicates.
  2. Open a new issue – if your idea is new. Please provide:
    • A clear explanation of the feature.
    • Why it would be useful.
    • Any examples or use cases.

📝 Submitting a Pull Request (PR)

  • Create a Fork: Fork this repository to your GitHub account to start working on your changes.
  • Create a New Branch: Create a new branch for your contribution (e.g., hacktoberfest-<your-branch-name>).
  • Make Changes: Make your changes in your branch. Ensure your changes are complete and functional before submission.
  • Add Project to the Project List/ProjectList.md - add your name and a link to the Github project you added
  • Commit Your Changes: Add a descriptive commit message (e.g., Added a new Python script for data analysis).
  • Push Your Branch: Push your branch to your forked repository on GitHub.
  • Create a PR: Submit a pull request to this repository. Include a brief description of what you’ve changed or added.

Our team will review your PR and provide feedback. If everything looks good, your contribution will be merged into the main project!

--

💻 Development Workflow

  1. Fork and clone the repo: 
    git clone https://github.com/hackelite01/hacktoberfest2024.git
cd hacktoberfest2024
  2. Create a new branch for your feature/bugfix: 
    git checkout -b feature-branch
  3. Make your changes, ensuring your code adheres to the project’s coding standards.
  4. Push your branch and create a pull request.

--

🤝 Community Guidelines

  • Respect Community Members: Treat others as you would like to be treated. We encourage open discussions, but please keep them civil and productive.
  • Follow the Code of Conduct: Our Code of Conduct outlines the