mirror of
https://github.com/LBPUnion/ProjectLighthouse.git
synced 2025-08-01 01:38:39 +00:00
[skip ci] Add api doc section to contributor's guide
This commit is contained in:
parent
4dbaec82e8
commit
5df6fbbb1c
2 changed files with 9 additions and 1 deletions
|
@ -6,6 +6,7 @@
|
|||
<Path>.github</Path>
|
||||
<Path>.gitignore</Path>
|
||||
<Path>.idea</Path>
|
||||
<Path>CONTRIBUTING.md</Path>
|
||||
<Path>DatabaseMigrations</Path>
|
||||
<Path>ProjectLighthouse.sln.DotSettings</Path>
|
||||
<Path>ProjectLighthouse.sln.DotSettings.user</Path>
|
||||
|
|
|
@ -90,4 +90,11 @@ Keep in mind while running database tests (which most tests are) you need to hav
|
|||
- You can skip CI runs for a commit if you specify `[skip ci]` at the beginning of the commit name. This is useful for
|
||||
formatting changes, etc.
|
||||
- When creating your first pull request, CI will not run initially. A team member will have to approve you for use of
|
||||
running CI on a pull request. This is because of GitHub policy.
|
||||
running CI on a pull request. This is because of GitHub policy.
|
||||
|
||||
### API Documentation
|
||||
|
||||
You can access API documentation by looking at the XMLDoc in the controllers under `ProjectLighthouse.Controllers.Api`
|
||||
|
||||
You can also access an interactive version by starting Lighthouse and accessing Swagger
|
||||
at `http://localhost:10060/swagger/index.html`.
|
Loading…
Add table
Add a link
Reference in a new issue