Skip to content

Latest commit

 

History

History
75 lines (49 loc) · 2.19 KB

CONTRIBUTING.md

File metadata and controls

75 lines (49 loc) · 2.19 KB

Contributing to Juno

Thank you for your interest in contributing to Juno! We welcome all contributions—whether it's code, documentation, bug reports, feature ideas, or feedback.

How to Start?

If you’re unsure where to begin:

🚀 How to Contribute

1. Report Bugs or Suggest Features

  • Search existing issues to avoid duplicates.
  • Open an Issue for bugs or Discussion for ideas.

2. Set Up Your Environment

Follow HACKING.md for setup instructions.

3. Make Your Changes

🔹 Git Commands for Branch Workflow

# Step 1: Sync your local main branch
git checkout main
git pull upstream main  # Assuming 'upstream' points to junobuild/juno

# Step 2: Create a new branch (use descriptive names)
git checkout -b fix/login-bug      # For bug fixes
git checkout -b feat/add-dark-mode # For new features

# Step 3: Make changes, then commit
git add .
git commit -m "fix: resolve login timeout issue"

# Step 4: Push to your fork (replace 'origin' with your fork)
git push -u origin fix/login-bug

4. Test Your Changes

  • Run tests locally (see HACKING.md).
  • Verify functionality.

5. Run Checks

Before pushing your branch and creating a PR, ensure your code passes formatting, linting, and type checks by running:

npm run check:all

6. Submit a Pull Request (PR)

  1. Go to Juno’s Pull Requests and click "New PR".
  2. Select your fork/branch as the source.
  3. Follow the PR template (if any) and:
    • Link related issues (e.g., Closes #123).
    • Add screenshots for UI changes.

❓ Need Help?