Skip to content

Conversation

@myteron
Copy link
Contributor

@myteron myteron commented Nov 17, 2025

only contains draft for main readme to demonstrate new layout.

@myteron myteron marked this pull request as draft December 9, 2025 13:17
Signed-off-by: myteron <[email protected]>
Signed-off-by: myteron <[email protected]>
Signed-off-by: myteron <[email protected]>
Signed-off-by: myteron <[email protected]>
myteron and others added 4 commits December 12, 2025 12:18
Signed-off-by: Helge Wehder <[email protected]>
… up. fixed links in README.md

Signed-off-by: Helge Wehder <[email protected]>
Signed-off-by: Helge Wehder <[email protected]>
@myteron myteron marked this pull request as ready for review December 15, 2025 17:53
@BartKaras1128
Copy link
Contributor

Hi @myteron

I have a few suggestions naming-wise, but before I go put suggestions in, I would like to see what you think of these and whether we share a train of thought here.

I went through the new names you have and put some thoughts down for some of them. I will continue to write some of these out but in suggestions rather than in a big block of text if you agree with these. Let me know what you think.

pyscg-0040 = Good, I like the name change, it's a positive case name.

pyscg-0041 = Also like the name change, but this time its a negative case name "Dont do this".

Suggestions: "Externalise Configuration and Secrets"
	     "Seperate Deployment Configuration from Code"
	     "Use Runtime Configuration Loading"
	     "Implement External Configuration Management" (My Favourite)

pyscg-0042 = Also a grand name change, but it has no "call to action", so it differs from the others. How about "Clarify Operator Precedence"?

pyscg-0055 = Grand name change, positive case name.

pyscg-0043 = I don't like the name change to much here "Handle Mixed Character Encoding". How do you handle it, bit vague. Also, the whole example is locale specific. Maybe we can mention that in the title? If not, then just take the locale part out of these suggestions.

Suggestions: "Specify Locale and Encoding Explicitly"
	     "Define Character Encoding and Locale"

pyscg-0044 = Like the name change, positive case name, good link addition.

pyscg-0045 = Good name change, positive case name, good link additions too.

pyscg-0046 = Don't really like the name change here, the rest seem to be calls for action, but not this one. How about one of these:
	     "Encode Output for Target Context"
             "Handle Encoding Errors Gracefully"
	     "Use Context-Safe Encoding"

pyscg-0001 = This one is OK... maybe could be better. "Control" is bit vague. Maybe we can do "Use Precise Numeric Types"?

pyscg-0002 = Again "handle Integer Overflow" is vague, but secondly I think that "Handle Integer Overflow" is a bit inaccurate as a title here, as the rule isn't about handling integers in python specifically, but about handling integers in C libraries... maybe we could specify that in the title? 

Suggestions: "Manage C Extension Overflow"
             "Catch Library Overflow Exceptions"
             "Validate Inputs for Overflow Safety"

pyscg-0003 = I like the name change.

pyscg-0004 = I like it, clear and concise.

pyscg-0005 = Similar to pyscg-0001, "Control" is a bit vague. Kinda like it besides that. How about: "Specify Explicit Rounding Methods"?

pyscg-0006 = It's a negative case name. What if we flip it to "Use Numeric Float Comparisons"

pyscg-0007 = Same problem, its good, but its negative. What if we flip it to: "Use String Literal"

pyscg-0053 = Its ok... but it feels a bit vague. The rule really talks about using arithmetic operations instead of bitwise shifts, maybe the title could suggest that? What if we change it to "Use Artihmetic Over Bitwise Shifts"

pyscg-0008 = "Prevent" is another negative case name. How about one of these:

Suggestions: "Use static Format Strings"
	     "Apply Safe String Formatting"

pyscg-0009 = "Prevent" used again... "Don't use OS commands", maybe we should tell the user what to use instead, e.g "Use Native Python Modules". Could say "to prevent OS Injection"

pyscg-0010 = "Prevent" used again. How about "Use parameterized Queries to Prevent SQL Injection"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants