systemetric / shepherd-2

A rewrite of shepherd
Apache License 2.0
4 stars 0 forks source link

Setup CI #1

Open shardros opened 2 years ago

shardros commented 2 years ago

AS A shepherd developer I WANT to not be allowed to commit broken code to master SO THAT the user expierence is bug free DONE IS:

NOTES:

Minion3665 commented 2 years ago

Could we use something like black in leu of/in addition to a linter? That way we know the code will be entirely consistent while also not having to worry about many points of a stricter code style such as pycodestyle

shardros commented 2 years ago

There are many benifit to linters which autoformaters cannot solve, such as checking for methods which are too long, too many args.

Not to mention all of the error checking they do.

Personally I dislike black. Its very opionated on things which do matter. Sometimes you want to format arrays in a particular way because it's clearer to read. I trust the judgement of the people working on this project enough to trust that they will be able to format a document clearer than black.

I would suggest autopep8 instead. It only enforces PEP8 which I think is a good set of rules which are always true for cleaner code.

Black makes decisions about things which are sometimes true and that's worse than useless when it chooses wrong.

I sometimes feel like it chooses the worst possible style on purpose as a test of loyalty.

I know about fmt: on/off but that is just more noise and even less clean code than there was to begin with.

These are just my opions and I can be convinced otherwise.

Minion3665 commented 2 years ago

There are many benifit to linters which autoformaters cannot solve, such as checking for methods which are too long, too many args.

Not to mention all of the error checking they do.

Personally I dislike black. Its very opionated on things which do matter. Sometimes you want to format arrays in a particular way because it's clearer to read. I trust the judgement of the people working on this project enough to trust that they will be able to format a document clearer than black.

I would suggest autopep8 instead. It only enforces PEP8 which I think is a good set of rules which are always true for cleaner code.

Black makes decisions about things which are sometimes true and that's worse than useless when it chooses wrong.

I sometimes feel like it chooses the worst possible style on purpose as a test of loyalty.

I know about fmt: on/off but that is just more noise and even less clean code than there was to begin with.

These are just my opions and I can be convinced otherwise.

That's fair enough; autopep8 looks reasonable. How about using autopep8 for formatting and then pycodestyle for stuff which autoformatters can't catch?

shardros commented 2 years ago

Sounds good to me

shardros commented 2 years ago

@Minion3665 would you like to do this?

Minion3665 commented 2 years ago

@Minion3665 would you like to do this?

Sure thing; right now I'm at work so I'll do it when I'm on my break

shardros commented 2 years ago

Sure :) theres no huge rush

On Fri, 29 Jul 2022 at 10:08, Skyler @.***> wrote:

@Minion3665 https://github.com/Minion3665 would you like to do this?

Sure thing; right now I'm at work so I'll do it when I'm on my break

— Reply to this email directly, view it on GitHub https://github.com/systemetric/shepherd-2/issues/1#issuecomment-1199049065, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFYNLZK64T6FLGXMVA6CMDVWONPRANCNFSM5447HNJA . You are receiving this because you were mentioned.Message ID: @.***>

Minion3665 commented 2 years ago

image Requiring status checks to pass is blocked by making this public (is this planned?) or paying for github

shardros commented 1 year ago

I see no reason why not to make it public.

On Mon, 15 Aug 2022 at 23:56, Skyler @.***> wrote:

[image: image] https://user-images.githubusercontent.com/34243578/184734492-1ae316d3-c76f-4050-93b5-d75f53da5525.png Requiring status checks to pass is blocked by making this public (is this planned?) or paying for github

— Reply to this email directly, view it on GitHub https://github.com/systemetric/shepherd-2/issues/1#issuecomment-1215956895, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADFYNL6PN3Q2FNO7N46ABC3VZLDKRANCNFSM5447HNJA . You are receiving this because you were mentioned.Message ID: @.***>