Skip to content

Latest commit

 

History

History
112 lines (72 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

112 lines (72 loc) · 3.64 KB
Raw

Contributing Guidelines

We’re excited you want to contribute to the Flare Developer Hub! 🎉

Please follow these guidelines to ensure a smooth and productive collaboration.

🤝 How to Contribute

We welcome:

  • Pull Requests (PRs) for bug fixes, features, and documentation updates
  • Bug Reports for issues found
  • Feature Requests and suggestions

Contributing Workflow Summary

  1. Fork the Repository and create a new branch:

    git checkout -b feature/your-feature-name

  2. Commit Changes using the Conventional Commit format:

    git commit -m "feat(api): add support for new endpoints"

  3. Push the Branch to your fork:

    git push origin feature/your-feature-name

  4. Open a Pull Request (PR) on the main repository.

📝 Commit Message Guidelines

Follow the Conventional Commits format for clear and structured commit messages:

Format:

<type>(<scope>): <description>

Examples:

  • fix(api): correct response status for invalid input
  • feat(docs): add section for new API usage

Types:

Type Description
feat New feature
fix Bug fix
docs Documentation updates
chore Maintenance tasks
test Adding or improving tests
refactor Code improvements without feature changes
ci CI pipeline changes

Additional Notes:

  • Scope: Indicates the area of the project affected (e.g., api, docs, frontend).
  • Keep commit messages concise but descriptive.

🔄 Submitting a Pull Request (PR)

Important: All contributions will be licensed under the project’s license.

Best Practices

  1. Keep PRs Small and Focused:

    • Submit one PR per feature or bug fix.
    • Avoid combining unrelated changes.

  2. Discuss Large Changes First:

    • For significant features or major changes, open an issue to discuss it with maintainers before submitting a PR.

  3. Follow the Code Style:

    • Match the existing code style and structure.
    • Use the configured linter and formatter when applicable.

  4. Ensure Tests Pass:

    • Run the test suite and address any CI/CD pipeline failures.

  5. Handle Merge Conflicts Early:

    • If a merge conflict occurs, resolve it promptly.

🎨 Diagrams Style Guide

When contributing diagrams, follow the established visual style:

Element Light Mode Dark Mode
Arrow Width 1px 1px
Arrow Color #595959 #FFFFFF
Border Width 1px 1px
Border Color (Highlight) #E7125E #EF4A82
Border Color (Normal) #595959 #FFFFFF
Onchain Border Style Solid Solid
Offchain Border Style Dashed Dashed

Tip: Use the dashed style only if both onchain and offchain elements are displayed.

By following these guidelines, you’ll help maintain a high-quality, collaborative development environment. Thank you for contributing!