Skip to content

v1.2.1 - Enhanced Contribution Guidelines and Documentation

Latest
Latest

Choose a tag to compare

View all tags
@Amnoor Amnoor released this 14 Jan 13:06
· 6 commits to main since this release
v1.2.1
86ac2c3
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

Overview

Version 1.2.1 is focused on improving the project's documentation and making it easier for the community to contribute. This release introduces a comprehensive CONTRIBUTING.md file that provides clear, step-by-step guidelines for the entire contribution process. The README.md file has also been updated to reflect the project's current dependencies and to streamline its content.

What's New

  • Comprehensive Contribution Guidelines
    • A new CONTRIBUTING.md file has been added with detailed information on:
    • Branching strategy (main, develop, feature, bugfix, etc.).
    • A full contribution workflow, from forking the repository to submitting a pull request.
    • Commit message guidelines based on the Conventional Commits specification.
    • The pull request process and what to include in the description.
  • Updated Documentation
    • The README.md has been updated to remove the redundant "Contributing" section.
    • The "Built With" section has been corrected to show "BusyBox" instead of "Nginx" and "DockerSlim", accurately reflecting the current Docker image setup.

Upgrade Guide

Docker Users

To upgrade, pull the latest image from Docker Hub:

docker pull amnoorbrar/digital-clock:latest
docker run --rm -p 8080:80 amnoorbrar/digital-clock:latest

Building from Source

To build this version from source:

git clone https://github.com/Amnoor/Digital-Clock-Program.git
cd Digital-Clock-Program
git checkout v1.2.1
docker build -t digital-clock .
docker run --rm -p 8080:80 digital-clock

Compatibility

This release is fully backward compatible with previous versions. No breaking changes have been introduced.

Files Modified

  • .github (Folder, Unchanged):
    • workflows (Folder, Unchanged):
      • docker-push.yml (File, Unchanged)
  • assets (Folder, Unchanged):
    • background.jpg (File, Unchanged)
    • clock-icon.svg (File, Unchanged)
  • modules (Folder, Unchanged):
    • logs (Folder, Unchanged):
      • index.js (File, Unchanged)
  • style (Folder, Unchanged):
    • style.css (File, Unchanged)
  • .dockerignore (File, Unchanged)
  • CONTIBUTING.md (File, Added)
  • Dockerfile (File, Unchanged)
  • index.html (File, Unchanged)
  • index.js (File, Unchanged)
  • LICENSE (File, Unchanged)
  • README.md (File, Modified)

Verification

This release has been tested for:

  • ✅ Clarity and completeness of the new CONTRIBUTING.md guide.
  • ✅ Accuracy of the updated README.md file.
  • ✅ Continued core clock functionality without regressions.

Links

Contributors

Full Changelog:

Assets 2
Loading