Skip to content

Commit

Permalink
Initial setup
Browse files Browse the repository at this point in the history
  • Loading branch information
halgari committed Dec 7, 2023
1 parent 2f17f47 commit 9e14301
Show file tree
Hide file tree
Showing 6 changed files with 11 additions and 38 deletions.
4 changes: 2 additions & 2 deletions NexusMods.App.Template.sln → NexusMods.EventSourcing.sln
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{6ED01F9D
tests\SharedUsings.cs = tests\SharedUsings.cs
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Template", "src\NexusMods.Template\NexusMods.Template.csproj", "{A92DED3D-BC67-4E04-9A06-9A1B302B3070}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.EventSourcing", "src\NexusMods.EventSourcing\NexusMods.EventSourcing.csproj", "{A92DED3D-BC67-4E04-9A06-9A1B302B3070}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.Template.Tests", "tests\NexusMods.Template.Tests\NexusMods.Template.Tests.csproj", "{30CBEB4A-E0C0-4B11-A0CF-F97BFACEEF89}"
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "NexusMods.EventSourcing.Tests", "tests\NexusMods.EventSourcing.Tests\NexusMods.EventSourcing.Tests.csproj", "{30CBEB4A-E0C0-4B11-A0CF-F97BFACEEF89}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand Down
33 changes: 1 addition & 32 deletions README.md
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)
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
site_name: Nexus Mods App Template
site_url: https://nexus-mods.github.io/NexusMods.App.Template
site_url: https://nexus-mods.github.io/NexusMods.EventSourcing

repo_name: Nexus-Mods/NexusMods.App.Template
repo_url: https://github.com/Nexus-Mods/NexusMods.App.Template
repo_name: Nexus-Mods/NexusMods.App.EventSourcing
repo_url: https://github.com/Nexus-Mods/NexusMods.EventSourcing

extra:
social:
Expand Down
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>
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
<PropertyGroup>
<!-- https://github.com/pengweiqhca/Xunit.DependencyInjection#how-to-disable-xunitdependencyinjection -->
<EnableXunitDependencyInjectionDefaultTestFrameworkAttribute>false</EnableXunitDependencyInjectionDefaultTestFrameworkAttribute>
<RootNamespace>NexusMods.EventSourcing.Tests</RootNamespace>
</PropertyGroup>
</Project>
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
{
Expand Down

0 comments on commit 9e14301

Please sign in to comment.