Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a linter check with github actions #36

Open
Pradhvan opened this issue May 28, 2021 · 4 comments
Open

Add a linter check with github actions #36

Pradhvan opened this issue May 28, 2021 · 4 comments
Labels
automation demo api repo All issues on this repo should contain this label good first issue Good for newcomers

Comments

@Pradhvan
Copy link
Member

  • Add a linter to the project. Can it be black?
  • Add a respective GitHub action for lining analysis.
@Pradhvan Pradhvan added automation good first issue Good for newcomers demo api repo All issues on this repo should contain this label labels May 28, 2021
@slayer321
Copy link

Hey @Pradhvan, I am new to open source and will like to contribute to this project, can you guide me on what needs to be done.

@Pradhvan
Copy link
Member Author

Pradhvan commented May 28, 2021

Hi @slayer321 there is no GitHub action running with the repo.

So it would be good if you could add a GitHub action that checks linting errors when a new commit. This could also be used when a PR is made from any branch to master and on a successful merge to master.

You can take a reference from this post ignore the step with poetry and tests. The general idea would be the same.

@slayer321
Copy link

Hey @Pradhvan , thank you for adding the blog , I read it and also did my own research and I come up with this workflow gist . This is the first time I'm working with linter and Github Action so I don't know weather it is correct or not . Let me know what needs to be updated.

@Pradhvan
Copy link
Member Author

@slayer321 yes, something similar to this. You can create a branch and add it to the GitHub action. Test if that works and create a PR if everything works out.

Thank you for helping out. 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
automation demo api repo All issues on this repo should contain this label good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants