Skip to content
This repository has been archived by the owner on Oct 6, 2023. It is now read-only.

Code style

kalle (jag) edited this page Sep 29, 2022 · 4 revisions

Keep the codebase 'mergable'

For maintainability reasons this repository needs to be "mergable" with the original JamesNK/Newtonsoft.Json without major merge conflicts. This means some alterations are to be prohibited so that when doing the merge, git can do most of the most of the hard work for us.

Such prohibited alterations includes:

  • ❌ Moving/removing/renaming files and folders.

  • ❌ Alter source code files inside Src/Newtonsoft.Json/ and Src/Newtonsoft.Json.Tests/ where strictly not necessary.

  • ❌ Disconnecting the repository as a "fork" from JamesNK/Newtonsoft.Json

Any modifications done to files that does not exist in the origin repository is of course up for any alterations. For example:

  • ✔ Moving/removing/renaming/adding files and folders within the .github/, .circleci/, ci/, Src/Newtonsoft.Json-for-Unity/, and Src/Newtonsoft.Json-for-Unity.Tests/ folders.

  • ✔ Alter source code within any of the listed folders from the list item above.

  • ✔ Alter documentation files (*.md)

  • ✔ Alter configuration files (.gitignore, .gitattributes, .editorconfig, *.json, *.yml, etc.)

Clone this wiki locally