Skip to content

Latest commit

 

History

History
255 lines (181 loc) · 10.4 KB

CONTRIBUTING.md

File metadata and controls

255 lines (181 loc) · 10.4 KB
Raw

Contributing to SPROCTOR 🎯

We’re excited to have you contribute to the SPROCTOR project! Whether you're here to fix a bug, suggest a new feature, your contributions are highly appreciated!


Code of Conduct 📃

Please read and follow our Code of Conduct.


Star our Repository ⭐

Stars Forks Issues PRs Open PRs Closed


Need Help With The Basics? 🤔

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


Project Structure 📂

SPROCTOR/
├── _pycache_/                 # Some python files are included here
│   
├── .github/                   # GitHub-related configurations such as workflows, issue templates, etc
│   
├── Assets/                    # Contains image 
│   
├── Backend/                   # Contains all the python files used in the backend of the project 
│     
├── calenderApp/               # Contains the calender page
│   
├── contributor/               # Contains the contributor page
│   
├── GUI/                       # Contains graphic user interface (GUI) of the project
│   
├── CODE_OF_CONDUCT.md         # Some rules for the contributors      
│   
├── CONTRIBUTING.md            # Instructions for the contributors
│   
├── GSSoC-Ext.png                 
│   
├── heatmap_combined_20241009_144503.png       
├──
├── LICENSE                    # A permission to do something
├──
├── modle.png           
├──                                
├── PROJECT_STRUCTURE.md
├──           
├── Readme.md                  # Contains the instructions regarding the contributions
├──
├── repo_structure.txt
├──
├── requirements.txt               
├──
├── Suggested-Issues.md

First Pull Request ✨

  1. 🍴 Fork the Repository

    • Go to the repository page.
    • Click the Fork button (top right) to create a copy in your GitHub account.

  2. Clone Your Fork 💻

    • Open your terminal and run: 
      git clone https://github.com/your-username/SPROCTOR.git
    • Replace your-username with your GitHub username.

  3. Create a New Branch 🌿

    • Create a new branch for your work: 
      git checkout -b your-branch-name

  4. Make Your Changes 🛠️

    • Open the project files in your code editor and implement your changes.
    • Contact the project manager, Tanisha Lalwani, for any queries.

  5. Test Your Changes ✅

    • Test your changes locally by running the application and verifying functionality.

  6. 💬 Commit Your Changes

    • Once ready, commit your changes with a descriptive message:

      git add .
      git commit -m "Added feature X or Fixed issue Y"

  7. 📤 Push Your Changes

    • Push your changes to your forked repository: 
      git push origin your-branch-name

  8. Pull Request Process 🚀

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

  1. Review Changes 🔎
    • The project manager will review your PR, and if approved, your request will be merged.

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 project repository yet, you can do so by clicking on the "File" menu and selecting "Clone Repository."
  • Choose the project 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.
  1. Make Changes:
  • Make your changes to the code or files in the repository using your preferred code editor.
  1. 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.
  1. 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.
  1. Create a Pull Request:
  • Go to the GitHub website and navigate to your fork of the project 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.
  1. 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 project repository.

For Help And Support 💬


Contribution Guidelines 📝

  • Keep your code clean and well-documented.
  • Stick to best practices for the programming language you are contributing in.
  • Respect the folder structure and organization of the repository.

Contribution Points 🏆

All tasks will be assigned various levels based on complexity and required skills. Each level provides different points:

  • 🥇 Level 1: 10 Points
  • 🥈 Level 2: 25 Points
  • 🥉 Level 3: 45 Points

Code Style 💻

Please follow the existing code style in the project. Consistent code style helps maintain readability and makes it easier for everyone to contribute. Ensure that your code passes all linting and formatting checks before submitting.


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.

Writing Tests 🧪

If you’re adding a new feature or fixing a bug, please include tests to ensure that your changes don’t break existing functionality. Tests should be written using the existing testing framework in the project.


Documentation 📖

If your contribution changes how the package works, please update the relevant documentation. This includes updating comments, README files, and other markdown files as needed.


Reporting Issues 🐞

  • Navigate to the project's issues section :- Issues
  • Please kindly choose the appropriate template according to your issue.
  • Provide a clear and concise description of the issue.
  • Wait until someone looks into your report.
  • 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! 🚀