Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 1.55 KB

Contributing to BitBadges Chain

Thank you for your interest in contributing to BitBadges! This document provides guidelines for contributing to the project.

Getting Started

  1. Fork the repository
  2. Clone your fork locally
  3. Set up the development environment following the README

Development Workflow

Branching

  • Create feature branches from master
  • Use descriptive branch names: feature/add-xyz, fix/issue-123, docs/update-readme

Code Style

  • Follow existing code patterns and conventions
  • Run make lint before submitting PRs
  • Ensure all tests pass with make test

Commits

  • Write clear, concise commit messages
  • Reference issues when applicable: fix: resolve balance calculation (#123)

Pull Requests

  1. Ensure your branch is up to date with master
  2. Run the full test suite locally
  3. Create a PR with a clear description of changes
  4. Link any related issues
  5. Wait for CI to pass and request review

Reporting Issues

  • Search existing issues before creating a new one
  • Use issue templates when available
  • Include relevant details: version, environment, steps to reproduce

Code of Conduct

Be respectful and constructive in all interactions. We're building something together.

Questions?

  • Open a GitHub Discussion for general questions
  • Join our Discord for community support
  • Check the documentation for guides

License

By contributing, you agree that your contributions will be licensed under the project's existing license.