Skip to content

Latest commit

 

History

History
74 lines (50 loc) · 2.78 KB

CONTRIBUTING.md

File metadata and controls

74 lines (50 loc) · 2.78 KB
Raw

Contributing to FlowG

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to FlowG. These are mostly guidelines, not rules. Use your bet judgment, and feel free to propose changes to this document in a pull request.

How to ask for help?

The bug tracker is dedicated for Bug Reports and Feature Requests, the right place to ask questions is on the Discussion Board.

How Can I Contribute?

Reporting Bugs

Before submitting a bug report:

  • Check the discussions for a list of common questions and problems
  • Check the bug tracker for a list of similar reports

How do I submit a (good) bug report?

Bug reports are tracked as Github issues, create an issue of type Bug Report or Security Bug Report and provide the information requested by the form.

If your issue is a Security Bug Report and there is an associated CVE number, please fill the appropriate field in the form.

Requesting Features

No software is perfect, and everything can be improved.

Before submitting a feature request:

  • Check the discussions for a list of common questions and problems
  • Check the bug tracker for a list of similar requests

How do I submit a (good) feature request?

Feature requests are also tracked as Github issues, create an issue of type Feature Request and provide the information requested by the form.

Submitting Pull Requests

Here are some guidelines on how to format your PRs:

  • Use a descriptive title for the PR
  • Fill the information requested by the template
  • Prefix the title of your PR with the appropriate Gitmoji
  • Prefix your commit messages with the appropriate Gitmoji
  • Keep your PR up to date to the main branch by rebasing it, not using merges

If you don't follow those guidelines, you at least accept that a Code Owner will take the time to edit your PR to make it fit our guidelines.

Gitmoji should be typed out as text, not UTF-8 glyphs. They will be rendered by Github, giving a nice visual indicator of the kind of change you are submitting, and yet will still be easily "greppable".

License of your contributions

This project is Free and Open Source. It is released under the terms of the MIT License. Your contributions will also be released under the terms of this license.