Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
48 lines (34 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 2.42 KB

Contributing to Flowork Synapse

First off, thank you for considering contributing to Flowork! It's people like you that make the open-source community such an amazing place. We welcome any form of contribution, from reporting a bug to submitting a new feature.

How Can I Contribute?

🐞 Reporting Bugs

If you find a bug, please ensure the bug was not already reported by searching on GitHub under Issues.

If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

✨ Suggesting Enhancements

If you have an idea for a new feature or an improvement to an existing one, please open an issue to discuss it. This allows us to coordinate our efforts and prevent duplication of work.

When creating an enhancement suggestion, please:

  • Use a clear and descriptive title.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Explain why this enhancement would be useful to most Flowork users.

Pull Requests

We love pull requests! Here’s a quick guide on how to get your contributions merged:

  1. Fork the repository to your own GitHub account.
  2. Create a new branch for your changes. Please use a descriptive branch name (e.g., feature/add-new-trigger, fix/bug-in-scraper). 
    git checkout -b feature/YourAmazingFeature
  3. Make your changes to the codebase.
  4. Add comments to your code where necessary. We value clean and readable code.
  5. Commit your changes using a conventional commit message. This helps in generating changelogs. 
    git commit -m "feat: Add support for XYZ"
  6. Push your branch to your fork on GitHub. 
    git push origin feature/YourAmazingFeature
  7. Open a Pull Request to the main branch of the main Flowork repository.
  8. Provide a clear description of the problem and solution. Include the relevant issue number if applicable.

Styleguides

Git Commit Messages

We follow the Conventional Commits specification. In short, your commit messages should be structured as follows: