mvp-2003 / Quikz

Quiz app
GNU Affero General Public License v3.0
9 stars 21 forks source link

[Enhancement] SetUp github Actions #33

Closed shubhansu-kr closed 2 weeks ago

shubhansu-kr commented 2 weeks ago

Set Up .github Directory for Best Practices

Description:

We need to set up the .github directory to enforce code standards, streamline the contribution process, and ensure a consistent workflow across the project. This setup will include templates and configurations for pull requests, issues, code reviews, and more. The goal is to maintain high code quality and promote a smooth collaboration process.

Task List:

  1. Add Pull Request Template (PULL_REQUEST_TEMPLATE.md)

    • Define a clear template for contributors to follow when submitting PRs.
    • Include sections for breaking changes, assumptions, testing details, and screenshots.
  2. Add Issue Templates (ISSUE_TEMPLATE/)

    • Create separate templates for:
      • Bug reports
      • Feature requests
      • General tasks
    • Ensure each template gathers relevant information for clarity.
  3. Add Contributing Guidelines (CONTRIBUTING.md)

    • Define contribution rules (code styles, commit messages, PR process, etc.).
    • Include a clear description of how contributors should set up their development environment.
  4. Add Code of Conduct (CODE_OF_CONDUCT.md)

    • Establish behavior expectations for contributors to foster a positive community.
  5. Set up Code Owners (CODEOWNERS)

    • Assign code reviewers for specific areas of the codebase to streamline the review process.
  6. Set up Dependabot (dependabot.yml)

    • Automate dependency updates for the project.
    • Ensure regular checks for outdated dependencies.
  7. Add Security Policy (SECURITY.md)

    • Provide instructions for reporting security vulnerabilities.
    • Outline the security support for different project versions.
  8. Add Funding File (FUNDING.yml) (optional)

    • Enable the sponsor button for financial support if applicable.
  9. Set up GitHub Actions (Workflows)

    • Add automated CI/CD workflows to run tests, lint code, and ensure code quality on PRs.
    • Set up workflows for running tests automatically before merging any PRs.

Dependencies:

Acceptance Criteria:

Notes:

shubhansu-kr commented 2 weeks ago

Closed by #34