Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
147 lines (100 loc) · 4.91 KB

CONTRIBUTING.md

File metadata and controls

147 lines (100 loc) · 4.91 KB

Contributing to Hiero Hiero Enterprise Java

Thank you for your interest in contributing to Hiero Hiero Enterprise Java!

Table of Contents

Ways to Contribute

💻 Code Contributions

Get Started By Reading:

Quick Start:

  1. Find/create an issue → Issues
  2. Get assigned (comment "I'd like to work on this")
  3. Read Getting Started
  4. GPG and DCO sign commits Quickstart Signing

Detailed Docs:

⚠️ A Note on Breaking Changes

Avoid breaking changes when possible. If necessary:

  1. Create a new issue explaining the benefits
  2. Wait for approval
  3. Submit as a separate PR with:
    • Reasons for the change
    • Backwards compatibility plan
    • Tests
    • Changelog documentation

🐛 Bug Reports

Found a bug? Help us fix it!

Click here to submit a bug → Bug Reports

💡 Feature Requests

Have an idea? We'd love to hear it!

  1. Search existing requests - Avoid duplicates
  2. Create a Feature Request
  3. Describe:
    • What problem does it solve?
    • How should it work?
    • Example code (if applicable)

Want to implement it yourself? Comment on the issue and we'll assign you!

📝 Blog Posts

Want to write about Hiero Enterprise Java?

We welcome blog posts! Whether you're sharing a tutorial, case study, or your experience building with the SDK, we'd love to feature your content.

Quick overview:

Full guide with step-by-step instructions: Blog Post Guide

Developer Resources

Essential Guides

Guide What It Covers
Signing GPG + DCO commit signing
Rebasing Keeping branch updated
Merge Conflicts Resolving conflicts

Cheatsheet

First-Time Setup

# Fork on GitHub, then:
git clone https://github.com/YOUR_USERNAME/hiero-enterprise-java.git
cd hiero-enterprise-java
git remote add upstream https://github.com/hiero-ledger/hiero-enterprise-java.git

Making a Contribution

# Start new work
git checkout main
git pull upstream main
git checkout -b "name-of-your-issue"

# Make changes, then commit (signed!)
git add .
git commit -S -s -m "feat: add new feature"

# Push and create PR
git push origin "name-of-your-issue"

Keeping Branch Updated

git checkout main
git pull upstream main
git checkout your-branch
git rebase main -S

Full guide: Rebasing Guide

Thank you for contributing to Hiero Enterprise Java! 🎉