Skip to content
This repository has been archived by the owner on Aug 31, 2023. It is now read-only.

Latest commit

 

History

History
28 lines (19 loc) · 1.28 KB

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 1.28 KB

Contributing to DEADCELL

We encourage community feedback and contributions. Here are some ways you can get involved if you are interested.

Suggesting new features

We are always looking for new feature ideas! If you have an idea, check if others have submitted a similar idea in the Idea suggestion thread. You can upvote existing suggestions or submit a new one.

Finding an issue you can help with

If you're unsure what to work on, check the Issues page.

Making changes

Style guidelines

Please attempt to match the style of the surrounding code as much as possible.

File Names

Filenames should be all lowercase and can include underscores.

Variable Names

The names of variables (including function parameters) and data members are all lowercase, with underscores between words. Data members of classes (and structs) additionally have 'm_' prepended. For instance: local_variable, m_struct_data_member, m_class_data_member.

Function Names

The names of functions are all lowercase, with underscores between words.

Macro Names

Should be named with all capitals and underscores between words.

Testing

You should always test your code before submitting a pull request.