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

bug: Add a "How to contribute" section to the ReadMe. #4225

Open
gsk13340 opened this issue Aug 10, 2024 · 0 comments
Open

bug: Add a "How to contribute" section to the ReadMe. #4225

gsk13340 opened this issue Aug 10, 2024 · 0 comments
Assignees
Labels
bug Something isn't working

Comments

@gsk13340
Copy link

Describe the bug

The bug is more of an addition I would like to add to the ReadMe. I appreciate that the ReadMe is already very in depth. However, I think we should ad a code style guidelines for open source contributors.

To reproduce

  1. Go to ReadMe
  2. Click on "Contributor Guide"

Expected behavior

Naming Conventions:

Use camelCase for variables and functions.
Use PascalCase for class names.
Use uppercase letters for constants.

Commenting: Write clear, concise comments to explain complex logic. Use // for single-line comments and /* */ for multi-line comments.

Screenshots

No response

Browser information

No response

Application version

No response

Additional Context

No response

@gsk13340 gsk13340 added the bug Something isn't working label Aug 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants