generated from Nexus-Mods/NexusMods.App.Template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
11 additions
and
38 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,38 +1,7 @@ | ||
# NexusMods.App.Template | ||
# NexusMods.EventSourcing | ||
|
||
This is a template repository for `NexusMods.App.*` repositories. | ||
|
||
## How to use | ||
|
||
The following is a checklist of things you need to do after creating a new repository with this template. | ||
|
||
1) Update the project settings: | ||
1) `Settings` -> uncheck `Wikis` (under Features) | ||
2) `Settings` -> check `Automatically delete head branches` | ||
3) `Settings` -> `Collaborators and teams` -> `Add Teams` | ||
- Add `NexusMods.App Admin` with role `Admin` | ||
- Add `NexusMods.App Developers` with role `Maintain` | ||
- Remove yourself as a collaborator | ||
4) `Settings` -> `Rules` -> `Rulesets` and add a new one: | ||
- Call it `Branch PR Rules` | ||
- Add `Repository admin` to the `Bypass list` | ||
- Add `Include default branch` as a target | ||
- Only check the following branch protections: | ||
- `Restrict deletions` | ||
- `Require signed commits` | ||
- `Require a pull request` before merging with **1** required approvals | ||
- `Require status checks to pass before merging` | ||
- `Block force pushes` | ||
5) `Settings` -> `Pages` and change `Source` to **GitHub Actions** | ||
2) Rename the Solution and existing Projects | ||
3) Update the docs: | ||
1) Open [`mkdocs.yml`](./mkdocs.yml) and update the first four fields: | ||
- `site_name` and `site_url` | ||
- `repo_name` and `repo_url` | ||
2) Update the docs in [`docs`](./docs). At least change the [`index.md`](./docs/index.md) file. | ||
|
||
Finally, update this README. | ||
|
||
## License | ||
|
||
See [LICENSE.md](./LICENSE.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
...usMods.Template/NexusMods.Template.csproj → ...ntSourcing/NexusMods.EventSourcing.csproj
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
<Project Sdk="Microsoft.NET.Sdk"> | ||
<PropertyGroup> | ||
<RootNamespace>NexusMods.EventSourcing</RootNamespace> | ||
</PropertyGroup> | ||
<Import Project="$([MSBuild]::GetPathOfFileAbove('NuGet.Build.props', '$(MSBuildThisFileDirectory)../'))" /> | ||
</Project> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
2 changes: 1 addition & 1 deletion
2
tests/NexusMods.Template.Tests/Test1.cs → tests/NexusMods.EventSourcing.Tests/Test1.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
namespace NexusMods.Template.Tests; | ||
namespace NexusMods.EventSourcing.Tests; | ||
|
||
public class Test1 | ||
{ | ||
|