Skip to content

Latest commit

 

History

History
214 lines (152 loc) · 8.57 KB

CONTRIBUTING.md

File metadata and controls

214 lines (152 loc) · 8.57 KB
Raw

Contributing to ReVot

Welcome to our project! We're thrilled to have you contribute. Your efforts, big or small, make a difference. Please ensure that you follow our Code of Conduct in all interactions.


Need Help with the Basics? 🤔

If you're new to Git and GitHub, no worries! Here are some useful resources:


Project Structure 📂

ReVot/
├── .github/                  # Configuration files for GitHub, including issue templates
│   ├── ISSUE_TEMPLATE/       # Issue templates for reporting bugs and feature requests
│   │   ├── bug_report.md
│   │   ├── custom.md
│   │   └── feature_request.md
│   ├── workflows/            # CI/CD workflows
│   │   ├── PRValidator.yml
│   │   ├── ci-cd.yml
│   │   ├── issue_open_close.yml
│   │   ├── labeler.yml
│   │   ├── pr_merge.yaml
│   │   └── pr_raise.yml
├── deploy/                   # Deployment scripts and configurations
│   ├── after_push            # Scripts to run after a push
├── reverse_image_search_bot/ # Directory for the reverse image search bot
│   ├── images/               # Image assets
│   │   └── example_usage.png
│   ├── uploaders/            # Uploaders for images
│   │   ├── __init__.py
│   │   ├── base_uploader.py
│   │   ├── file_system.py
│   │   └── ssh.py
│   ├── __init__.py           # Package initializer
│   ├── bot.py                # Main bot logic
│   ├── commands.py           # Commands for the bot
│   ├── image_search.py       # Logic for image searching
│   ├── settings.example.py    # Example settings file
│   ├── settings.example1.py   # Another example settings file
│   └── settings.py           # Main settings file
│   └── utils.py              # Utility functions for the bot
├── .gitignore                # Git ignore file for untracked files
├── CODE_OF_CONDUCT.md        # Code of conduct for contributors
├── CONTRIBUTING.md           # Guidelines for contributing to the project
├── LICENSE                   # License file for the project
├── Pipfile                   # Pipfile for managing dependencies
├── Pipfile.lock              # Lock file for Pipfile dependencies
├── README.md                 # Main README file with project details
├── pre-installations.sh      # Script for pre-installation steps
└── run_bot.py                # Script to run the bot

First Pull Request ✨

  1. Star this repository Click on the top right corner marked as Stars at last.

  2. Fork this repository Click on the top right corner marked as Fork at second last.

  3. Clone the forked repository

git clone https://github.com/<your-github-username>/ReVot.git
  1. Navigate to the project directory
cd ReVot
  1. Create a new branch
git checkout -b <your_branch_name>
  1. To make changes
git add .
  1. Now to commit
git commit -m "add comment according to your changes or addition of features inside this"
  1. Push your local commits to the remote repository
git push -u origin <your_branch_name>

  1. Create a Pull Request

  2. Congratulations! 🎉 you've made your contribution


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 repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
    • Choose the 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 repository.
    • You should see a button to "Compare & pull request" between your fork and the original repository. Click on it.

  8. 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.

  9. 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 repository.


Good Coding Practices 🧑‍💻

  1. Follow the Project's Code Style

    • Maintain consistency with the existing code style (indentation, spacing, comments).
    • Use meaningful and descriptive names for variables, functions, and classes.
    • Keep functions short and focused on a single task.
    • Avoid hardcoding values; instead, use constants or configuration files when possible.

  2. Write Clear and Concise Comments

    • Use comments to explain why you did something, not just what you did.
    • Avoid unnecessary comments that state the obvious.
    • Document complex logic and functions with brief explanations to help others understand your thought -process.

  3. Keep Code DRY (Don't Repeat Yourself)

    • Avoid duplicating code. Reuse functions, methods, and components whenever possible.
    • If you find yourself copying and pasting code, consider creating a new function or component.

  4. Write Tests

    • Write unit tests for your functions and components.
    • Ensure your tests cover both expected outcomes and edge cases.
    • Run tests locally before making a pull request to make sure your changes don’t introduce new bugs.

  5. Code Reviews and Feedback

    • Be open to receiving constructive feedback from other contributors.
    • Conduct code reviews for others and provide meaningful suggestions to improve the code.
    • Always refactor your code based on feedback to meet the project's standards.

Pull Request Process 🚀

When submitting a pull request, please adhere to the following:

  1. Self-review your code before submission.
  2. Include a detailed description of the functionality you’ve added or modified.
  3. Comment your code, especially in complex sections, to aid understanding.
  4. Add relevant screenshots to assist in the review process.
  5. Submit your PR using the provided template and hang tight; we'll review it as soon as possible! 🚀

Issue Report Process 📌

To report an issue, follow these steps:

  1. Navigate to the project's issues section :- Issues
  2. Provide a clear and concise description of the issue.
  3. Avoid spamming to claim an issue. Patience is key!
  4. Wait until someone looks into your report.
  5. Begin working on the issue only after you have been assigned to it. 🚀

Thank you for contributing 💗

We truly appreciate your time and effort to help improve our project. Feel free to reach out if you have any questions or need guidance. Happy coding! 🚀