Skip to content

Latest commit

 

History

History
280 lines (203 loc) · 11.3 KB

CONTRIBUTION.md

File metadata and controls

280 lines (203 loc) · 11.3 KB
Raw

📜 Contributing to PrithWe

This document will guide you through the process of contributing to our repository. We value the time and effort of our contributors, and we strive to create an inclusive and collaborative community. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.


Table of Contents

  1. 📏 Code of Conduct
  2. 🤝 How to Contribute
  3. 🎨 Style Guides
  4. 🚀 Getting Started
  5. 📚 Additional Resources
  6. 📈 Development Workflow
  7. 🚩 Issue Report Process
  8. 🤔 Need Help regarding some basics?
  9. 🚀 Pull Request Process
  10. 🤝 Community Guidelines
  11. 📑 Documentation
  12. ✅ Code Reviews
  13. 🚀 Feature Requests
  14. ☘️ Spread the Word

📏 Code of Conduct

Please note we have a code of conduct please follow it in all your interactions with the project.


🤝 How to Contribute

🐞 Reporting Bugs

If you find a bug, please create an issue using the Bug Report Template. Be sure to include detailed information such as the steps to reproduce the bug, the expected outcome, and the actual outcome.

💡 Suggesting Enhancements

Have a great idea for a new feature? We'd love to hear it! Open an issue using the Feature Request Template and describe your enhancement in detail.

🔄 Pull Requests

We welcome pull requests for bug fixes, features, and documentation improvements. To ensure your pull request is reviewed promptly, please adhere to the following guidelines:

  • Fork the repository and create a new branch for your work.
  • Follow the Style Guides.
  • Ensure your code is well-documented and includes tests.
  • Reference any related issues in your pull request description.

🎨 Style Guides

📜 Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally.

💻 Code Style

  • Use meaningful variable and function names.
  • Write comments and documentation where necessary.

🚀 Getting Started

We welcome contributions! To contribute to this project, follow these detailed steps:

🍴 Forking the Repository

  • Navigate to the main repository.
  • Click on the "Fork" button in the upper right corner of the repository page. This will create a copy of the repository in your GitHub account.

📥 Cloning the Repository

  • Clone your forked repository to your local machine using the following command: 
    git clone https://github.com/<your-username>/prithwe.git
  • Replace <your-username> with your GitHub username and prithwe with the name of the repository you just forked.

🌿 Creating a Branch

  • Navigate into the cloned repository: 
    cd prithwe
  • Create a new branch for your feature or bug fix: 
    git checkout -b <branch-name>
  • Replace <branch-name> with a descriptive name for your branch, such as feature/add-new-feature or bugfix/fix-issue.

✨ Making Changes

  • Implement your changes in the new branch you created.
  • Ensure that your code follows the project's coding standards and guidelines.
  • Test your changes thoroughly to ensure they work as expected.

📝 Commit Your Changes

  • Stage your changes for commit: 
    git add .
  • Commit your changes with a descriptive commit message: 
    git commit -m "Add detailed description of what your commit does"
  • Provide a clear and concise commit message that explains what changes you have made and why.

📤 Pushing Changes to Your Fork

  • Push your changes to the branch in your forked repository: 
    git push origin <branch-name>

🔧 Creating a Pull Request

  • Go to your forked repository on GitHub.
  • Click on the "Compare & pull request" button for the branch you just pushed.
  • Provide a descriptive title and detailed description for your pull request.
  • Explain what changes you have made, why you made them, and any other relevant information.
  • Submit the pull request to the main repository.

🛠 Review Process

  • Your pull request will be reviewed by the maintainers of the project.
  • Be responsive to any feedback or questions they may have.
  • Make any necessary changes as requested by the maintainers.

🎉 Merge

  • Once your pull request is approved, it will be merged into the main repository.
  • Congratulations! You have successfully contributed to the project.

Alternatively contribute using GitHub Desktop

  1. Open GitHub Desktop: Launch GitHub Desktop and log in to your GitHub account if you haven't already.

  2. Clone the Repository:

    • If you haven't cloned the PrithWe repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the PrithWe repository from the list of repositories on GitHub and clone it to your local machine.

  3. Switch to the Correct Branch:

    • Ensure you are on the branch that you want to submit a pull request for.
    • If you need to switch branches, you can do so by clicking on the "Current Branch" dropdown menu and selecting the desired branch.

  4. Make Changes: Make your changes to the code or files in the repository using your preferred code editor.

  5. Commit Changes:

    • In GitHub Desktop, you'll see a list of the files you've changed. Check the box next to each file you want to include in the commit.
    • Enter a summary and description for your changes in the "Summary" and "Description" fields, respectively. Click the "Commit to " button to commit your changes to the local branch.

  6. Push Changes to GitHub: After committing your changes, click the "Push origin" button in the top right corner of GitHub Desktop to push your changes to your forked repository on GitHub.

  7. Create a Pull Request:

  • Go to the GitHub website and navigate to your fork of the PrithWe repository.
  • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  1. Review and Submit:

    • On the pull request page, review your changes and add any additional information, such as a title and description, that you want to include with your pull request.
    • Once you're satisfied, click the "Create pull request" button to submit your pull request.

  2. Wait for Review: Your pull request will now be available for review by the project maintainers. They may provide feedback or ask for changes before merging your pull request into the main branch of the PrithWe repository.


📈 Development Workflow

When working on the project, please follow these guidelines:

  1. Always work on a new branch for each separate issue or feature.
  2. Keep your branch up to date with the main repository's master branch.
  3. Write clear and descriptive commit messages.
  4. Test your changes thoroughly before submitting a pull request.
  5. Keep discussions polite and respectful.

🚩 Issue Report Process

  1. Go to the project's issues.
  2. Select the template that better fits your issue.
  3. Give proper description for the issues.
  4. Don't spam to get the assignment of the issue.
  5. Wait for till someone is looking into it !.
  6. Start working on issue only after its assigned to you.
  7. Don't create a duplicate issue.
  8. Check the issues first before making a new issue to avoid duplicate issues.

🤔 Need Help regarding some basics?

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


🚀 Pull Request Process

  1. Ensure that you have self reviewed your code.
  2. Make sure you have added the proper description for the functionality of the code.
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon.

🤝 Community Guidelines

We expect all contributors to adhere to the following community guidelines:

  1. Be respectful and considerate towards others.
  2. Use inclusive language and promote a welcoming environment.
  3. Avoid personal attacks, harassment, or discrimination.
  4. Keep discussions on-topic and constructive.
  5. Help others and contribute positively to the community.

📑 Documentation

  • Document any significant changes or additions to the codebase.
  • Provide clear and concise explanations of the functionality, usage, and any relevant considerations.

✅ Code Reviews

  • Be open to feedback and constructive criticism from other contributors.
  • Participate in code reviews by reviewing and providing feedback.

🚀 Feature Requests

  • Suggest new features or improvements that you believe would enhance the project.

☘️ Spread the Word

  • Share your experience and the project with others.
  • Spread the word about the project on social media, developer forums, or any relevant community platforms.
  • Thank you for your valuable contribution and for being a part of the Clueless Community! Together, we can make a difference. 🚀

📚 Additional Resources


Thank you for contributing to PrithWe! Your efforts help us make a positive impact on environmental awareness and action.

Happy Contributing 🔥