Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
124 lines (75 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

124 lines (75 loc) · 3.04 KB

🤝 Contributing to GitHub Contribution Graph Hack

First of all, thank you for considering contributing to this project! ❤️
This is an open-source, educational, and creative project built to explore GitHub contribution graph patterns in a fun and responsible way.

All kinds of contributions are welcome — from UI ideas to core logic improvements.

🌟 What You Can Contribute

You can help improve this project in many ways:

🧠 Script & Logic Improvements

  • Improve commit-generation logic
  • Optimize performance or reduce unnecessary commits
  • Add new configuration options (CLI flags, env vars)
  • Improve pattern parsing or validation

🐛 Bug Fixes

  • Fix edge cases in date calculations
  • Handle invalid or malformed pattern.json
  • Improve error messages and failure handling

🎨 Developer Experience

  • Improve CLI output or animations
  • Add flags like --dry-run, --quiet, or --year
  • Improve cross-platform compatibility

📖 Documentation

  • Improve README instructions
  • Add examples of pattern.json
  • Fix typos or unclear explanations

🛠️ Getting Started

1️⃣ Fork the Repository

Click the Fork button at the top-right of the repository.

2️⃣ Clone Your Fork

git clone https://github.com/your-username/github-pattern-committer.git
cd github-pattern-committer

3️⃣ Create a New Branch

git checkout -b feature/your-feature-name

Good branch name examples:

  • fix/date-calculation
  • feature/dry-run-mode
  • enhancement/cli-flags

💻 Development Guidelines

  • Keep the project simple and readable
  • Follow existing code style and structure
  • Avoid unnecessary dependencies
  • Ensure commits created by the script remain legitimate Git commits
  • Do not add anything that violates GitHub’s Terms of Service

✅ Commit Message Guidelines

Use clear and meaningful commit messages:

  • feat: add dry-run option
  • fix: handle invalid pattern.json
  • refactor: simplify commit loop
  • docs: update README examples

🧪 Testing Your Changes

Before opening a Pull Request:

  • Test with a small pattern first
  • Verify commit dates are correct
  • Confirm no unintended commits are created
  • Ensure the script runs without errors

📤 Submitting a Pull Request

  1. Push your branch to your fork
  2. Open a Pull Request against the main branch
  3. Clearly explain:
    • What you changed
    • Why the change is needed
    • Any potential side effects

Screenshots or logs are appreciated when relevant.

📜 Code of Conduct

  • Be respectful and constructive
  • Welcome beginners and first-time contributors
  • No harassment, spam, or abusive behavior

⚠️ Disclaimer

This project generates real Git commits with custom dates for educational and artistic purposes only. Contributors must ensure their changes do not encourage misuse or abuse.

🙌 Thank You

Every contribution — big or small — is appreciated.

If you have ideas, questions, or suggestions, feel free to open an Issue.

Happy hacking (responsibly) 😄