Skip to content

Latest commit

 

History

History
122 lines (75 loc) · 3.6 KB

Contributing.md

File metadata and controls

122 lines (75 loc) · 3.6 KB
Raw

🌟 Contributing to DevDocsHub

Thank you for considering contributing to DevDocsHub! We’re excited to welcome developers of all levels. Whether you’re fixing bugs, adding new features, or improving documentation, your help is invaluable.

Please follow the guidelines below to make the contribution process easy and effective for everyone.

🚀 Getting Started

Step 1: Fork the Repository

To contribute to DevDocsHub, fork the repository to your GitHub account:

Step 2: Clone the Forked Repository

Clone your fork to your local machine:

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

Don't forget to replace your-username with your actual GitHub username!

Step 3: Create a New Branch

Before making any changes, create a new branch to keep your work organized:

git checkout -b your-feature-name

Use a clear and descriptive name for your branch, such as fix-navbar-issue or add-new-feature.

Step 4: Make Your Changes

Now it’s time to make your improvements! Here are a few things you could contribute:

  • Bug Fixes
  • New Features
  • Documentation Enhancements

Make sure your code follows the project’s coding guidelines (see below 👇).

Step 5: Commit Your Changes

Once you're happy with your changes, stage and commit them to your branch:

git add .
git commit -m "Briefly describe what you've changed"

Step 6: Push to GitHub

Push your changes to your forked repository:

git push origin your-feature-name

Step 7: Open a Pull Request

To get your changes reviewed and merged into the main project:

  • Go to your forked repository on GitHub.
  • Navigate to the Pull requests tab.
  • Click New pull request and select your branch.

Once submitted, a project maintainer will review your code. 🚀

🧑‍💻 Code Style Guidelines

To keep the codebase clean and consistent, please adhere to these guidelines:

  • Python Code: Follow PEP 8 for Python code.
  • Commit Messages: Use clear, descriptive commit messages in the imperative mood (e.g., "Add new button" instead of "Added new button").
  • Testing: Ensure all existing tests pass, and if possible, write tests for new functionality you’ve added.

🛠 Reporting Issues

Found a bug? Have a great idea for a feature? We’d love to hear from you!

  1. Check Existing Issues: Before creating a new issue, please check if the issue has already been reported.
  2. Open a New Issue: If it hasn’t been reported yet, open a new issue and clearly describe:
    • What the issue is
    • How to reproduce it
    • Suggested solutions, if any

🎯 Pull Request Guidelines

When opening a pull request (PR):

  • Clearly explain the purpose of your PR in the description.
  • If the PR addresses an issue, link it using the format: Fixes #issue-number.
  • Ensure your code is clean, passes all tests, and is ready for review.

We’ll do our best to review your PR as quickly as possible. 🙌

🏆 Acknowledgments

Thank you for taking the time to contribute! Whether you’re improving documentation, squashing bugs, or proposing new features, we appreciate your effort to help make DevDocsHub better.

💬 Join the Discussion

Feel free to join our community! You can:

  • Open an issue for suggestions, questions, or discussions.
  • Share your feedback and thoughts to help us improve DevDocsHub.

Happy coding! 😊