-
Notifications
You must be signed in to change notification settings - Fork 57
chore: add CONTRIBUTING.md #307
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
nuskey8
wants to merge
1
commit into
main
Choose a base branch
from
chore/contributing-md
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| # Contributing | ||
|
|
||
| ## Dependencies | ||
|
|
||
| The following are used in the development of Lua-CSharp: | ||
|
|
||
| - [Visual Studio Code](https://code.visualstudio.com/) / [Rider](https://www.jetbrains.com/rider/) | ||
| - [Unity Editor](https://unity3d.com/unity/editor) (optional) | ||
| - .NET SDK and runtimes | ||
| - [CSharpier](https://csharpier.com/) (optional, C# code formatter) | ||
|
|
||
| ## Build | ||
|
|
||
| ```sh | ||
| dotnet build Lua.slnx -c Release | ||
| ``` | ||
|
|
||
| If you only want to build the NuGet package project: | ||
|
|
||
| ```sh | ||
| dotnet build src/Lua/Lua.csproj -c Release | ||
| ``` | ||
|
|
||
| ## Run Tests | ||
|
|
||
| ```sh | ||
| dotnet test tests/Lua.Tests/Lua.Tests.csproj -c Release | ||
| ``` | ||
|
|
||
| The test project includes a set of `.lua` conformance-style tests inherited from the official Lua repository. Most of them are expected to pass, but a few known cases are currently marked with the `ExpectedFailure` category in the test suite. | ||
|
|
||
| To run the test project while excluding those known failures: | ||
|
|
||
| ```sh | ||
| dotnet test tests/Lua.Tests/Lua.Tests.csproj -c Release --filter "TestCategory!=ExpectedFailure" | ||
| ``` | ||
|
|
||
| This is the same filter used in GitHub Actions when packing and publishing the NuGet package. | ||
|
|
||
| ## Unity | ||
|
|
||
| The extension package for Unity is located in the `Assets/Lua.Unity` directory within the Unity project, which is located in `src/Lua.Unity`. | ||
|
|
||
| The Unity package does not include the source code of the core package. During development, a local package containing the debug DLL is added as `com.nuskey8.lua.unity.internal`. | ||
|
|
||
| ## Publishing Packages | ||
|
|
||
| Publishing to NuGet is handled by a workflow via GitHub Actions. This will run whenever you push a `v.*.*.*` tag. | ||
|
|
||
| Before this runs, make sure that the versions of `Directory.Build.props` and the `package.json` file inside your Unity project match. Otherwise, the CI will fail. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sounds more natural