Skip to content

Add a contributing guide #279

@Ge0

Description

@Ge0

So I have started contributing to this repository, and as I have my own habits in my Flutter projects – where I work alone – I figured it would be interesting to have a guide and set up some minimal tooling so the code can receive external contributions in a more efficient way.

Format the code consistently

One thing I am thinking about at the moment is to add some continuous integration which checks that the code is correctly formatted with dart format. I have the habit to format my code and as this one isn’t formatted the way dart format expects it to be, I end up with a reformatted file while this is not expected for pull requests, so I have to be really careful with my contributions.

With formatted files we would not have to overwrite other people’s latest modifications and, normally, the diffs would be easier to review.

Anything else?

Let me know your thoughts. Would be really happy to both discuss about them and to work on these.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions