Skip to content

FreetimeMaker/GeoWeather-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

137 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

GitHub Organization Guide

Repository Setup

Beschreibung

Ein produktionsreife REST API fΓΌr Wetter-App mit Cloud-Sync, History-Archiv und Freemium-Features

Topics

  • weather-api
  • rest-api
  • nodejs
  • express
  • postgresql
  • docker
  • open-source

Links


Branch Protection Rules (main)

Anforderungen vor Merge:

  • βœ… Pull request reviews erforderlich (1 approval)
  • βœ… Dismiss stale PR approvals bei neuen commits
  • βœ… Require status checks to pass:
    • CI/CD Pipeline erfolgreich
    • Code Coverage >= 80%
  • βœ… Require branches to be up to date before merging
  • βœ… Require conversation resolution before merging
  • βœ… Require signed commits

Wer kann Push:

  • Maintainers only

Automatisch Delete Head Branches: βœ…


Collaborators & Teams

Teams

  • Maintainers: Kernel team mit Merge-Rechten
  • Contributors: Community Contributors
  • Reviewers: Code Reviewers

Permissions

  • Maintainers: Admin
  • Contributors: Write
  • Reviewers: Read

Actions & Automation

CI/CD

  • Build & Test auf jedem Push
  • Security Audit
  • Code Coverage Report

Scheduled Jobs (Optional)

# Weekly
- Security Vulnerability Scan
- Dependency Updates

# Monthly
- Performance Benchmarks
- Code Quality Report

Community

Discussion Categories

  • πŸ“– Announcements: Updates und News
  • πŸ’‘ Ideas: Feature Suggestions
  • πŸ“š Q&A: Fragen und Antworten
  • πŸŽ‰ Show & Tell: Projekte die GeoWeather API nutzen

Labels

Bug Labels

  • bug - Something isn't working
  • critical - Critical bug / breaks API
  • needs-investigation - Needs investigation
  • regression - A bug that didn't exist before

Feature Labels

  • enhancement - New feature or request
  • good-first-issue - Good for newcomers
  • help-wanted - Extra attention needed
  • roadmap - Future plans

Status Labels

  • in-progress - Currently being worked on
  • reviewing - Under review
  • blocked - Blocked by another issue
  • wontfix - Will not be fixed

Type Labels

  • documentation - Documentation update
  • security - Security-related issue
  • performance - Performance improvement
  • dependencies - Dependency updates

Priority Labels

  • priority: critical - Critical
  • priority: high - High priority
  • priority: medium - Medium priority
  • priority: low - Low priority

Releases & Versioning

Semantic Versioning

  • Major (X.0.0): Breaking changes
  • Minor (0.X.0): New features (backward compatible)
  • Patch (0.0.X): Bug fixes

Release Checklist

  • Update version in package.json
  • Update CHANGELOG.md
  • Create git tag
  • Build Docker image
  • Push to Docker Hub
  • Create GitHub Release
  • Deploy to production

Documentation Strategy

README.md

  • Feature overview
  • Quick start guide
  • Links to more docs
  • Status badges

docs/

  • API.md - API-Dokumentation
  • ARCHITECTURE.md - System-Design
  • DEPLOYMENT.md - Deployment-Guides

Wiki (Optional)

  • Installation guides
  • Configuration
  • Troubleshooting
  • Best practices

Community Guidelines

Welcome

  • πŸ‘‹ Respectful and inclusive
  • 🀝 Value diverse perspectives
  • πŸ™ Thank contributors
  • πŸŽ“ Mentor newcomers

Not Welcome

  • πŸ’¬ Spam/Promotion
  • 😠 Harassment/Discrimination
  • 🚫 Off-topic discussions
  • ⚠️ Rule violations

Metrics & Analytics

Wichtige KPIs

  • Anzahl Stars
  • Forks
  • Contributors
  • Open Issues
  • Release Frequency
  • Community Activity

Monitoren mit

  • GitHub Insights
  • OSSF Metrics
  • Dependabot Reports

Contact & Support

Channels

  • πŸ“§ Email: support@geoweather.com
  • πŸ’¬ GitHub Discussions
  • πŸ› GitHub Issues
  • πŸ“± Social Media: @geoweatherapi

Support Levels

  • Community: GitHub Issues (Best effort)
  • Freemium: Email + Priority support
  • Enterprise: Dedicated support

Best Practices

Code Review

  • Konstruktives Feedback
  • Mindestens 1 Approval
  • Linting & Tests mΓΌssen passen
  • Documentation aktualisieren

Commit Messages

<type>(<scope>): <subject>

<body>

<footer>

Typen:

  • feat: - New feature
  • fix: - Bug fix
  • docs: - Documentation
  • style: - Code style
  • refactor: - Code refactoring
  • perf: - Performance
  • test: - Tests
  • chore: - Build/Dependencies

Pull Requests

  • Eine Feature pro PR
  • Beschreibliche PR-Titel
  • Referenziere Issues
  • FΓΌge Tests hinzu
  • Update Dokumentation

Monitoring & Maintenance

Regular Tasks

  • Review open PRs
  • Triage new issues
  • Update dependencies
  • Security audits
  • Monitor performance

Quarterly

  • Release planning
  • Roadmap review
  • Community feedback
  • Contribution analysis

About

The Official Payment API for GeoWeather.

Resources

License

Stars

Watchers

Forks

Contributors