Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

84 lines (57 loc) · 2.63 KB

Contributing to Unique Project Ideas Repository

Thank you for considering contributing to the Unique Project Ideas repository! Your contributions are valuable and help grow this collection into a resourceful hub for developers and learners worldwide. Below are the guidelines for contributing to this repository.

How to Contribute

1. Fork the Repository

  • Navigate to the top-right corner of the repository and click the Fork button.
  • This creates a copy of the repository under your GitHub account.

2. Clone the Repository

  • Clone the forked repository to your local machine using the following command:
$ git clone https://github.com/king04aman/unique-project-ideas.git

3. Create a Branch

  • Create a new branch to isolate your changes:
$ git checkout -b <branch-name>

4. Make Your Changes

  • Add or update files as per the repository structure.
  • Ensure your changes are relevant, clear, and well-documented.

5. Test Your Changes

  • Verify that your changes are functional and adhere to the repository’s purpose.

6. Commit and Push Changes

  • Commit your changes with a meaningful message:
$ git add .
$ git commit -m "<describe your changes>"
  • Push your branch to your forked repository:
$ git push origin <branch-name>

7. Submit a Pull Request

  • Navigate to the original repository and click on Pull Requests.
  • Click on New Pull Request and select your branch.
  • Provide a detailed description of the changes and submit your pull request.

Contribution Guidelines

  1. Follow the Repository Structure

    • Place files in their respective directories.
    • For new ideas, create a detailed idea-<number>.md file in the ideas/ directory.

  2. Adhere to Code and Documentation Standards

    • Ensure code snippets are properly formatted.
    • Use markdown formatting for documentation.

  3. Be Respectful and Collaborative

    • Respect the community and maintain a professional tone in all interactions.
    • Be open to feedback and willing to collaborate with others.

  4. Keep Commits Clean

    • Use meaningful commit messages.
    • Avoid including unnecessary files or changes in your commits.

  5. Report Issues

    • If you encounter a problem, create a detailed issue in the repository.
    • Use the provided issue templates for clarity.

Need Help?

If you need any assistance or have questions about the contribution process, feel free to open an issue or contact the repository maintainers.

Thank you for contributing! Together, we can make this repository an incredible resource for the community.