[Tasks] Repository Management

[kaihiroi]

GitHub

• Templates
  • Create pull request template (.github/PULL_REQUEST_TEMPLATE.md)
  • Create issue templates (.github/ISSUE_TEMPLATE/**)
    • Bug report
    • Feature request
    • Support request
    • New release
• Settings
  • Set up branch protection rules
    • Require a pull request before merging
    • Require status checks to pass before merging
    • Require conversation resolution before merging
    • Require signed commits
    • Include administrators
  • Create organization project & link board
    • Todo, InProgress, InReview, Done
  • Set up issue and pull request labels
• GitHub Actions (Workflows)
  • Continuous Integration
    • Create .github/workflows/ci.yml
    • Set up jobs
      • format-check
        • setup forge fmt
      • tests
      • slither
      • coverage
  • Review Workflow Changes
    • Set up review CI for workflow definition files

Documentation

• README
  • Create README.md
  • Contents
    • Project overview
    • Installation instructions
    • Documentation guide
    • Contributing guide
    • License guide
• Changelog
  • Create CHANGELOG.md
  • Contents
    • Changelog overview
    • Example release log
• Contributing guidelines
  • Create CONTRIBUTING.md
  • Contents
    • Greeting
    • Reporting issues guide
    • Submitting pull requests guide
    • Coding style guide
      • Modifier naming #3
    • Release process guide
    • Versioning policy
    • Changelog rules guide
• Code of Conduct
  • Create CODE_OF_CONDUCT.md with Template
  • Fill the contract method
• Security policy
• License
  • Create LICENSE.md (blocking task: choose license)

Need to decide

• Choose appropriate license like MIT, Apache 2.0, GNU GPL
  • MIT
• Determine versioning strategy (Semantic Versioning, CalVer, etc.)
  • SemVer

Notifications and Reporting

• Set up status badges for the README
• Decide on the communication channel for the community (Telegram, Discord, Slack, Discourse, etc.)
  • Evaluate the features and limitations of each platform
  • Consider the preferences and familiarity of the team and community members
  • Choose the most suitable platform based on the project's needs
• Set up notifications and report generation for the selected communication channel
  • Add notification job
  • Configure various report outputs (coverage, analysis results, etc.)