This repository has been archived by the owner on Dec 23, 2022. It is now read-only.
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
1 parent
f598aa0
commit c060fbb
Showing
5 changed files
with
75 additions
and
55 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 +1,48 @@ | ||
# Contributing to NSudo | ||
# Contributing to NSudo | ||
|
||
## How to become a contributor | ||
- Direct contributions | ||
- **Create pull requests directly.** | ||
- Please send e-mails to Mouri_Naruto@Outlook.com if you have any | ||
questions. | ||
- Feedback suggestions and bugs. | ||
- We use GitHub issues to track bugs and features. | ||
- For bugs and general issues please | ||
[file a new issue](https://github.com/M2Team/NSudo/issues/new). | ||
|
||
## Code contribution guidelines | ||
|
||
### Prerequisites | ||
- Visual Studio 2017 version 15.9 or later. | ||
- Install from here: http://visualstudio.com/downloads | ||
- You also need install ARM and ARM64 components. | ||
- Windows 10 version 1507 SDK or later. | ||
- You need to change the Windows SDK version in the project properties if the | ||
version of Windows 10 SDK I used isn't installed on your PC. | ||
- You also need install ARM and ARM64 components when you installing the | ||
Windows 10 Version 1703 SDK or later. | ||
- (Optional but recommend) If you want to reduce the release mode binaries size | ||
for x86, x64 and ARM64 port of NSudo, you can use VC-LTL. | ||
- VC-LTL GitHub Repository: https://github.com/Chuyu-Team/VC-LTL | ||
- How to use VC-LTL to optimize NSudo binaries size: | ||
- Download VC-LTL binary pack from | ||
https://github.com/Chuyu-Team/VC-LTL/releases/latest. | ||
- Unpack the VC-LTL binary pack and double-click install.cmd in the unpack | ||
folder. | ||
|
||
## Code style and conventions | ||
- C++: [C++ Core Guidelines](https://github.com/isocpp/CppCoreGuidelines/blob/master/CppCoreGuidelines.md) | ||
- C#: Follow the .NET Core team's [C# coding style](https://github.com/dotnet/corefx/blob/master/Documentation/coding-guidelines/coding-style.md) | ||
|
||
For all languages respect the [.editorconfig](https://editorconfig.org/) file | ||
specified in the source tree. Many IDEs natively support this or can with a | ||
plugin. | ||
|
||
### Copying files from other projects | ||
The following rules must be followed for PRs that include files from another | ||
project: | ||
* The license of the file is | ||
[permissive](https://en.wikipedia.org/wiki/Permissive_free_software_licence). | ||
* The license of the file is left intact. | ||
* The contribution is correctly attributed in the [Readme](Readme.md) | ||
file in the repository, as needed. |
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
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