Skip to content

Commit

Permalink
add - Added new contribution rules
Browse files Browse the repository at this point in the history
---

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
  • Loading branch information
AptiviCEO committed Oct 15, 2024
1 parent 3941782 commit a382bdb
Showing 1 changed file with 20 additions and 3 deletions.
23 changes: 20 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <SHELLSCRIPT>` 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:
Expand Down Expand Up @@ -221,9 +232,15 @@ Review the commit history if you want to get a deep insight about the changes.
### Feedback?
If you have issues with this version, report to us by [making a new issue ticket](https://github.com/Aptivi/PROJECT/issues/new).
### Sum hashes
To verify integrity of your download, compare the SHA256 sum of your downloaded file with the following information:
```

Also, the `CHANGES.TITLE` file should be changed to match the version whose development finished but tag not pushed, as long as it follows this format:
Two new lines are applied intentionally so that the hash list gets rendered in a way that you'd expect, because the hash sum list gets populated automatically. Also, the `CHANGES.TITLE` file should be changed to match the version whose development finished but tag not pushed, as long as it follows this format:

```
[servicing] PROJECT v1.0.0: Release Name
Expand All @@ -234,11 +251,11 @@ The type at the beginning is necessary as it can tell us and the users in what s
* `alpha`: Indicates that this release is an alpha version
* `beta`: Indicates that this release is a beta version
* `release`: Indicates that this release is a major release (i.e. changes the major part and/or the minor part)
* `servicing`: Indicates that this release is a minore release (i.e. changes the build part and/or the patch part)
* `servicing`: Indicates that this release is a minor release (i.e. changes the build part and/or the patch part)

## Assistance of AI

Although artifical intelligence (AI) is a next-gen technology that every company are leaning to, which we are proud of, but when contributing code or other things to this project, we rely on human work to ensure maximum quality. This means that you are not allowed to use any kind of AI assistance to generate code and non-code contributions, such as ChatGPT and others, in fear of licensing issues, potential security issues, and current hallucination issues. Any usage of such tools when contributing will be immediately rejected.
Although artifical intelligence (AI) is a next-gen technology that every company is leaning to, which we are proud of, but when contributing code or other things to this project, we rely on human work to ensure maximum quality. This means that you are not allowed to use any kind of AI assistance to generate code and non-code contributions, such as ChatGPT and others, in fear of licensing issues, potential security issues, and current hallucination issues. Any usage of such tools when contributing will be immediately rejected.

## Engagement with the Community

Expand Down

0 comments on commit a382bdb

Please sign in to comment.