Skip to content

Commit 80b5b5d

Browse files
committed
add - Added new contribution rules
--- Effective today, we're setting up new policies regarding contributing new code. This is to ensure maximum compatibility with Windows development environments for C# projects. --- Type: add Breaking: False Doc Required: False Backport Required: False Part: 1/1
1 parent 31d5238 commit 80b5b5d

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,17 @@ Your pull requests should follow the template.
1010

1111
You should be descriptive about what your change is trying to do and what's your opinion about how it affects the whole project. Moreover, it's vital to test your changes before trying to start a pull request to ensure that there are no problems in your initial version. **Always** draft your pull requests.
1212

13+
## Windows compatibility
14+
15+
*This doesn't apply to projects that don't use C# or aren't exclusive to Windows.*
16+
17+
When contributing changes to any part of the code, especially when creating files, your pull requests should follow the below requirements:
18+
19+
- File names should not contain forbidden characters, such as `/ \ : * ? " < > |`, and control characters, such as a new line, as files with such names don't sit well with Windows.
20+
- File names should always be treated as case sensitive, even if *nix systems allow you to create files with same name but different casing, as files that fall into this category don't sit well with Windows.
21+
- When creating shell scripts in Windows, you should give it executable permissions with `git update-index --chmod=+x <SHELLSCRIPT>` prior to committing, as Windows in general has no concept of Unix permissions.
22+
- In general, make sure that any of your changes don't cause incompatibilities with Windows in any way in both build-time and run-time.
23+
1324
## Code guidelines
1425

1526
When it comes to coding your changes, they should follow the below coding guidelines to retain the style of our projects' code. These are the below code guidelines:

0 commit comments

Comments
 (0)