[READ-ONLY] Mirror of https://github.com/excaliburjs/Excalibur. 🎮 Your friendly TypeScript 2D game engine for the web 🗡️
excaliburjs.com
excalibur
excaliburjs
game-development
game-engine
game-framework
gamedev
games
html5-canvas
typescript
docs: Fix semantic headings (#2161)
Fixes the semantic heading levels of the Contributing Guide.
+9
-9
+9
-9
.github/CONTRIBUTING.md
+9
-9
.github/CONTRIBUTING.md
···
1
1
# How to Contribute
2
2
3
-
#### Code of Conduct
3
+
## Code of Conduct
4
4
5
5
This project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
6
6
7
-
#### Questions
7
+
## Questions
8
8
9
9
Have questions? Ask them in our [forum]!
10
10
11
-
#### Table of Contents
11
+
## Table of Contents
12
12
13
13
- [Reporting Bugs](#reporting-bugs)
14
14
- [Suggesting Improvements](#suggesting-improvements)
···
117
117
// ex.Feature.MyClass will be exposed
118
118
```
119
119
120
-
## Styleguides
120
+
## Style guides
121
121
122
-
#### Code
122
+
### Code
123
123
124
124
A number of our code formatting rules are enforced via linting. When you build Excalibur on your computer, the linter will make sure that certain aspects of your code are formatted properly. Additionally:
125
125
···
127
127
- All methods must explicitly specify their access modifier (public, private, etc.)
128
128
- Use the `TitleCase` naming convention for classes/interfaces, with a lowercase first letter for variables (`camelCase`).
129
129
130
-
#### Commit Messages
130
+
### Commit Messages
131
131
132
132
Follow the guidelines below to help maintain a readable and informative git history:
133
133
···
168
168
See also: #200, #300
169
169
```
170
170
171
-
#### Tests
171
+
### Tests
172
172
173
173
All features, changes, and bug fixes must be tested by specifications (unit tests). Write tests to cover any potential scenarios your code introduces.
174
174
···
187
187
});
188
188
```
189
189
190
-
#### Visual Examples
190
+
### Visual Examples
191
191
192
192
Excalibur uses Storybook for writing visual tests and examples. These can be interactive and showcase different parts of the engine or specific features. We sometimes embed these examples in the documentation site.
193
193
194
194
Use `npm run visual` to start Storybook. Stories are written in the `src/stories` directory.
195
195
196
-
#### Documentation
196
+
### Documentation
197
197
198
198
- Add JSDoc comments to all public and protected methods
199
199
- Link to other classes using the TypeDoc double bracket notation.