Skip to content

Commit

Permalink
Merge pull request #31 from aaron-ross-sanchez/file-contributing
Browse files Browse the repository at this point in the history
updated CONTRIBUTING.md Code Style and Standards
  • Loading branch information
kaxada committed Feb 18, 2024
2 parents e062eeb + 955ca0f commit db3d0d5
Showing 1 changed file with 30 additions and 2 deletions.
32 changes: 30 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,36 @@ After generating those values,

## Code Style and Standards

BadgingAPI follows a specific code style and coding standards. Please make sure to adhere to these standards when contributing.

BadgingAPI follows a specific code style and coding standards. Please make sure to adhere to these standards when contributing:

- **Variables and functions**: camelCase
````markdown
myVariable = 10;

function exampleFunction() {
return "Hello, World!"
};
- **Classes and constructors**: PascalCase
````markdown
class MyClass {
constructor(value) {
this.value = value;
}
};
- **Filenames, constants, and environment variables**: Snake_case
````markdown
my_file_name.txt

const MAX_ATTEMPTS = 5;

DATABASE_URL = "localhost:3000"
- **HTML attributes and CSS class names**: Kebab-case
````markdown
<div class="my-element"></div>

.my-element {
color: red;
};
### Issue Tracking

If you're looking for ways to contribute but don't have specific code changes in mind, you can check the [issue tracker](https://github.com/badging/BadgingAPI/issues) for BadgingAPI on GitHub. You might find issues marked as "help wanted" or "good first issue."
Expand Down

0 comments on commit db3d0d5

Please sign in to comment.