search

ankushbhardwxj / codemon

cli to win programming contests
https://pypi.org/project/codemon/
MIT License
26 stars 12 forks source link

Contribution Guidelines #37

Closed Enigmage closed 3 years ago

Enigmage commented 3 years ago

To streamline the development process and prevent any future conflicts from happening, it might be a good idea to add clear and concise Contribution guidelines and Code of Conduct to the documentation of this repo, specially in light of the recent PR conflicts that happened.

Some example guidelines we can add for contributors:

etc etc.

We can also include Coding Style guidelines (indentation rules etc). All this can prevent future conflicts and might help the project greatly.

@ankingcodes If you're interested in this suggestion I can make PRs to help add the necessary documentation to the project.

ankushbhardwxj commented 3 years ago

Hey @Enigmage - Thanks for the suggestion, but we are not looking to make changes to the README. Regarding Coding Style guidelines, I'd be more interested if you'd setup some kind of automation CI tool like preetier, which would review every PR made to this repository for its code style and indentation. Do you have any ideas in this regard ?

Enigmage commented 3 years ago

There would be no need to change the README, just a new file Contributing.md will be added, link to which will be visible to anyone making a PR to this repo. About the CI system, yeah I can help setting up something like pycodestyle through github actions that will check code style in all PRs according to PEP 8 standards. So should I close this issue and open a new one for setting up CI ?

ankushbhardwxj commented 3 years ago

Yeah you can close this and create a new issue for CI. However, please present some more options for style checking. I'm not sure if pycodestyle is reliable.

Enigmage commented 3 years ago

Yeah sure I'll definitely look into more options and keep you updated.