Skip to content

Latest commit

 

History

History
66 lines (50 loc) · 2.72 KB

CONTRIBUTING.md

File metadata and controls

66 lines (50 loc) · 2.72 KB
Raw

Contributing to Awesome-Deblurring-Resources

Thank you for considering contributing to this repository! Your contributions help build a comprehensive and valuable resource for researchers and practitioners in image and video deblurring. Here are some guidelines to help you get started.

How to Contribute

  1. Fork the Repository: Fork the repository to your GitHub account.
  2. Clone Your Fork: Clone your forked repository to your local machine. 
    git clone https://github.com/user-name/repo-name.git
  3. Create a New Branch: Make a new branch for your changes. 
    git checkout -b feature/your-feature-name
  4. Make Your Changes: Add your contributions to the appropriate section.
  5. Commit and Push: Commit your changes with a descriptive message and push to your fork. 
    git add .
git commit -m "Add new paper/dataset: [Paper/Model/Project Name]"
git push origin feature/your-feature-name
  6. Create a Pull Request: Go to the original repository and create a pull request from your fork.

Guidelines for Contributing

1. Adding New Papers

  • Format: Add new papers to the appropriate yearly section in the following format: 
    | Venue | Paper | Link |
|-------|-------|------|
  • Paper Link: Use the paper's official URL (arXiv, conference/journal webpage).
  • Code Link: Use the model name as the link text if available (e.g., [ModelName](https://github.com/user/repo)); otherwise, use a generic link.

2. Adding New Datasets

  • Format: Add new datasets to the "Datasets" section in the following format: 
    | Name | Description | Link |
|------|-------------|------|
  • Description: Provide a concise description of the dataset (what it includes, its purpose, etc.).
  • Link: Include the official URL for the dataset.

3. Typos/Bug Fixes

  • If you find any errors, such as incorrect links, typos, or misplaced papers/datasets, please follow these steps:
    • Describe the Issue: Clearly describe the issue in the pull request or commit message.
    • Propose a Fix: Update the incorrect link, correct the placement, or fix the typo directly in the relevant section.
    • Commit Message: Use a descriptive commit message, e.g., "Fix broken link for [Paper Name]" or "Correct paper placement for [Year]."

General Guidelines

  • Ensure all links are valid and point to the correct resources.
  • Avoid duplicate entries.
  • Follow the existing formatting for consistency.
  • Add only relevant and high-quality resources.

Code of Conduct

We adhere to a Code of Conduct that requires contributors to be respectful, inclusive, and collaborative.

Thank you for contributing!