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

Feat: Testing and Linting #155

Merged
merged 8 commits into from
Nov 14, 2023
Merged

Conversation

CodeWithEmad
Copy link
Member

This will add a Makefile, clean the code with isort and black, and fix typing issues.
Closes #151

@CodeWithEmad
Copy link
Member Author

CodeWithEmad commented Oct 4, 2023

@regisb Should I modify the gh_refs_path function so that "refs": "GITHUB_API" + gh_refs_path() is replaced by "refs": gh_refs_path("openedx/frontend-app-account")?
Also, don't we wanna have make isort and make format run in the test.yml?

@CodeWithEmad CodeWithEmad force-pushed the feat/test-lint branch 2 times, most recently from fbb24e5 to 7612a41 Compare October 4, 2023 09:24
@regisb
Copy link
Contributor

regisb commented Oct 5, 2023

Should I modify the gh_refs_path function so that "refs": "GITHUB_API" + gh_refs_path() is replaced by "refs": gh_refs_path("openedx/frontend-app-account")?

Yes, good idea!

Also, don't we wanna have make isort and make format run in the test.yml?

I think that's convenient, yes.

Copy link
Contributor

@regisb regisb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's a great step forward, and the PR looks good as it is. @arbrandes and @kdmccormick I'm curious to hear what you think?

@CodeWithEmad
Copy link
Member Author

I think that's a great step forward, and the PR looks good as it is.

I'm happy to hear that!

black and isort steps added and gh_refs_path reformatted.

@CodeWithEmad CodeWithEmad requested a review from regisb October 5, 2023 12:10
@regisb regisb requested review from arbrandes and kdmccormick and removed request for regisb October 5, 2023 12:47
@CodeWithEmad
Copy link
Member Author

CodeWithEmad commented Oct 6, 2023

I have resolved the conflicts that were caused by merging my last pull request.

Also I had another thing in mind. Shouldn't we update documents to inform contributors about running make ... commands before creating new PRs?

.github/workflows/test.yml Outdated Show resolved Hide resolved
tutormfe/plugin.py Outdated Show resolved Hide resolved
.github/workflows/test.yml Outdated Show resolved Hide resolved
@CodeWithEmad
Copy link
Member Author

Just a friendly reminder @kdmccormick @arbrandes

Copy link
Contributor

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for you patience @CodeWithEmad . I think this is a great improvement!

My only concern is that we should pin the development dependencies in order to keep the PR build stable--see my comment below.

.github/workflows/test.yml Outdated Show resolved Hide resolved
instead of only returning heads or tags, and appending it to a GitHub url, the function now accepts an owner and a name and return the full refs path
Copy link
Contributor

@regisb regisb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot Emad! This is very useful. I'll let @arbrandes review, squash and merge.

@CodeWithEmad CodeWithEmad marked this pull request as draft November 6, 2023 16:30
@CodeWithEmad CodeWithEmad marked this pull request as ready for review November 6, 2023 16:31
@arbrandes arbrandes merged commit 0ef470b into overhangio:master Nov 14, 2023
1 check passed
@CodeWithEmad CodeWithEmad deleted the feat/test-lint branch November 14, 2023 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Add Makefile, Linting, and Testing to old plugins
4 participants