From dc40ba564f64c19d30b3f59aaf3540a64f6ae449 Mon Sep 17 00:00:00 2001 From: Aptivi CEO Date: Tue, 15 Oct 2024 22:35:39 +0300 Subject: [PATCH] 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 --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e0f03b7..9beaec9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,6 +10,17 @@ Your pull requests should follow the template. 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. +## Windows compatibility + +*This doesn't apply to projects that don't use C# or aren't exclusive to Windows.* + +When contributing changes to any part of the code, especially when creating files, your pull requests should follow the below requirements: + + - 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. + - 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. + - When creating shell scripts in Windows, you should give it executable permissions with `git update-index --chmod=+x ` prior to committing, as Windows in general has no concept of Unix permissions. + - 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. + ## Code guidelines 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: