Regarding Quality check

80 views
Skip to first unread message

Diya Khetarpal

unread,
Dec 30, 2024, 6:58:26 PM12/30/24
to sympy

Hi Contributors,

I hope this message finds you well.

I am new to contributing to the SymPy project, and while I was working on my pull request, I came across a few doubts regarding the process. I would appreciate any guidance or advice you can offer.

  1. Quality Checks on Local Machine: Is it possible to perform code quality checks (such as linting, formatting, and static analysis) on my local machine before submitting a pull request (PR)? I would like to ensure that my code adheres to the project’s quality standards before making a PR.

  2. Committing Changes for Quality Check: I have noticed that during the review process, I often need to commit changes multiple times to pass the code quality checks. Is it okay to make these repeated commits in the same PR to address issues raised by the checks, or is there a preferred approach to minimize such changes?

I am eager to learn and improve my contributions, and I want to make sure I follow the best practices for submitting high-quality code. Your insights will be greatly appreciated.

Thank you for your time and support. I look forward to hearing from you.

Best regards,

Diya

Diya Khetarpal

unread,
Dec 30, 2024, 6:58:27 PM12/30/24
to sympy

Hi Contributors,

I hope this message finds you well.

I am new to contributing to the SymPy project, and While I was working on my pull request, I came across a few doubts regarding the process. I would appreciate any guidance or advice you can offer.

Sangyub Lee

unread,
Jan 3, 2025, 4:21:11 AM1/3/25
to sympy
I don't think that it is necessary for you to clean up the commits before merging PR.
But usually, it is good demonstration of your skills of programming and handling responsibility for the tasks, and it can affect your approval for GSOC or any other endorsement, so it is better to try your best for improving the quality and skills for using respective tools.
I note that people who don't do that are often the people who don't self-improve, don't help others and not transparent about their progress, ...

Oscar Gustafsson

unread,
Jan 3, 2025, 3:19:47 PM1/3/25
to sy...@googlegroups.com
I think you should read up on git commit --amend, git rebase -i, and git push --force-with-lease. These are all crucial concepts not to end up with lots of minor spurious commits. With that said, you will learn with experience and by messing up.

BR Oscar 

--
You received this message because you are subscribed to the Google Groups "sympy" group.
To unsubscribe from this group and stop receiving emails from it, send an email to sympy+un...@googlegroups.com.
To view this discussion visit https://groups.google.com/d/msgid/sympy/f67f45cf-3eb1-4b01-839a-305dd4996f80n%40googlegroups.com.
Reply all
Reply to author
Forward
0 new messages