Skip to content

Implement Pull Request Template for Contribution Standardization #94

@Nitya-003

Description

@Nitya-003

Description

The project README.md references a PR Template, but the actual file is missing from the repository. This leads to inconsistent Pull Requests where contributors forget to mention which branch they are targeting or fail to describe their changes.

To ensure the "Contribution Branch only" rule is followed and new models are correctly documented, we need to establish a formal .github/PULL_REQUEST_TEMPLATE.md.

Proposed Template Content

I suggest the template includes the following sections to match the project's current needs:

## 📝 Description
Provide a brief summary of the changes or the specific feature added.

## 🎯 Type of Change
- [ ] 🐞 Bug fix (non-breaking change which fixes an issue)
- [ ] ✨ New feature (non-breaking change which adds functionality)
- [ ] 🧠 New AI Model (added to `new_models/` folder)
- [ ] 📝 Documentation update
- [ ] 🎨 UI/UX improvement

## 🧪 How Has This Been Tested?
- [ ] Tested via CLI
- [ ] Tested via Streamlit
- [ ] Tested via PySimpleGUI
- [ ] Tested with specific hardware (Webcam/External Camera)

## 🚩 Checklist:
- [ ] My code follows the project's style guidelines.
- [ ] I have performed a self-review of my own code.
- [ ] I am submitting this PR to the **contribution branch** (not main).
- [ ] I have updated the `requirements.txt` if new libraries were used.
- [ ] (If adding a model) I have placed the `.hdf5` file in the correct directory.

## 📸 Screenshots (if applicable)
Add screenshots or GIFs of the UI or Terminal output.

Tasks to Complete

  • Create a .github/ directory (if not already created for Issue Templates).
  • Create a file named PULL_REQUEST_TEMPLATE.md inside the .github/ folder.
  • Update the link in the README.md under the PR Template section to point to this new file.

Why this is important

  1. Enforcement: It reminds contributors every time they open a PR that they must target the contribution branch.
  2. Efficiency: Maintainers won't have to ask "What does this code do?" or "Did you test the Streamlit app?"—the info will be right there.
  3. Professionalism: It aligns the repo with top-tier open-source standards.

I had love to work on this issue and Submit a PR.
Labels: documentation, ECWOC'26, ECWOC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions