Union/ProjectLighthouse
1
0
Fork 0
mirror of https://github.com/LBPUnion/ProjectLighthouse.git synced 2025-08-22 10:19:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

[skip ci] Add api doc section to contributor's guide

Browse source
This commit is contained in:
jvyden 2022-02-01 14:46:24 -05:00
commit 5df6fbbb1c
No known key found for this signature in database
GPG key ID: 18BCF2BE0262B278
2 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
.idea/.idea.ProjectLighthouse/.idea/indexLayout.xml generated
View file

@ -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>

9
CONTRIBUTING.md
View file

@ -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`.