Difference between revisions of "Coding guidelines"
Jump to navigation
Jump to search
(Created page with "== All projects == # Never commit any credentials (logins, passwords, JWT tokens, certificates etc) into github repo == New projects based on Ethora == # Don't create pull r...") |
|||
| (2 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
== All projects == | == All projects == | ||
# Never commit any credentials (logins, passwords, JWT tokens, certificates etc) into github | # 🚫 '''Never commit any credentials (logins, passwords, JWT tokens, certificates etc)''' into Ethora github repository. | ||
== New projects based on Ethora == | == New projects based on Ethora == | ||
# Don't create pull requests or branches within Ethora github repo for any custom changes you have built or need built for an external project. | # 🚫 Don't create pull requests or branches within Ethora github repo '''for any custom changes you have built or need built for an external project'''. | ||
# You may create issues / feature requests for something you need built, however any such request will be only treated as a feedback in regards to roadmap priorities for the Ethora core engine development. Any core engine development will remain a copyright of Ethora foundation (currently owned and managed by Dappros Ltd, UK). You should not expose any confidential, sensitive or commercially valuable information via your feature requests and communications within Ethora repository. You acknowledge that the publicly available github Ethora repository does not represent all of the Ethora project knowledge and information in its entirety. You acknowledge that the features you request or suggest may have already been in development or planned for development. | # ⚠️ You may create issues / feature requests for something you need built, however any such request will be only treated as a feedback in regards to roadmap priorities for the Ethora core engine development. Any core engine development will remain a copyright of Ethora foundation (currently owned and managed by Dappros Ltd, UK). You should '''not expose any confidential, sensitive or commercially valuable information''' via your feature requests and communications within Ethora repository. You acknowledge that the publicly available github Ethora repository does not represent all of the Ethora project knowledge and information in its entirety. You acknowledge that the features you request or suggest may have already been in development or planned for development. | ||
# Don't commit any project specific code or logic into Ethora github repo | # 🚫 '''Don't commit any 3rd party project specific code''' or logic into Ethora github repo | ||
# Don't commit any code subject to 3rd party ownership into Ethora github repo | # 🚫 '''Don't commit any code subject to 3rd party ownership''' into Ethora github repo | ||
== Ethora core engine developers == | == Ethora core engine developers == | ||
==== Copyright & license notice ==== | |||
Include the following copyright and license notice header into all project code files. | Include the following copyright and license notice header into all project code files. | ||
<nowiki> | <nowiki> | ||
/* | /* | ||
Copyright 2019- | Copyright 2019-2022 (c) Dappros Ltd, registered in England & Wales, registration number 11455432. All rights reserved. | ||
You may not use this file except in compliance with the License. | You may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at https://github.com/dappros/ethora/blob/main/LICENSE. | You may obtain a copy of the License at https://github.com/dappros/ethora/blob/main/LICENSE. | ||
Note: linked open-source libraries and components may be subject to their own licenses. | |||
*/ | */ | ||
</nowiki> | </nowiki> | ||
== Licensing == | |||
'''A) Open-source license option.''' | |||
Your Ethora-based project should include a copy of the license file typically available under COPYING and LICENSE file names in the root of the repository. | |||
Please ensure these license files remain as part of your repository and that you keep publicly open and available your Ethora based project code and its derivatives. Please ensure you retain the copyright & license notice in the headers of project code files. Doing otherwise is a violation of license terms. | |||
'''B) Commercial license option.''' | |||
There is no need to include a license file into your project repository if your company/project has a commercial license contract from Ethora foundation (represented by Dappros Ltd, UK) or one of its official distributor partners. | |||
You should remove the COPYING and LICENSE files in such case if you have your local copy duplicated from the main Ethora repository, as your code is governed by custom license terms. | |||
Latest revision as of 08:56, 7 July 2022
All projects
- 🚫 Never commit any credentials (logins, passwords, JWT tokens, certificates etc) into Ethora github repository.
New projects based on Ethora
- 🚫 Don't create pull requests or branches within Ethora github repo for any custom changes you have built or need built for an external project.
- ⚠️ You may create issues / feature requests for something you need built, however any such request will be only treated as a feedback in regards to roadmap priorities for the Ethora core engine development. Any core engine development will remain a copyright of Ethora foundation (currently owned and managed by Dappros Ltd, UK). You should not expose any confidential, sensitive or commercially valuable information via your feature requests and communications within Ethora repository. You acknowledge that the publicly available github Ethora repository does not represent all of the Ethora project knowledge and information in its entirety. You acknowledge that the features you request or suggest may have already been in development or planned for development.
- 🚫 Don't commit any 3rd party project specific code or logic into Ethora github repo
- 🚫 Don't commit any code subject to 3rd party ownership into Ethora github repo
Ethora core engine developers
Copyright & license notice
Include the following copyright and license notice header into all project code files.
/* Copyright 2019-2022 (c) Dappros Ltd, registered in England & Wales, registration number 11455432. All rights reserved. You may not use this file except in compliance with the License. You may obtain a copy of the License at https://github.com/dappros/ethora/blob/main/LICENSE. Note: linked open-source libraries and components may be subject to their own licenses. */
Licensing
A) Open-source license option.
Your Ethora-based project should include a copy of the license file typically available under COPYING and LICENSE file names in the root of the repository.
Please ensure these license files remain as part of your repository and that you keep publicly open and available your Ethora based project code and its derivatives. Please ensure you retain the copyright & license notice in the headers of project code files. Doing otherwise is a violation of license terms.
B) Commercial license option.
There is no need to include a license file into your project repository if your company/project has a commercial license contract from Ethora foundation (represented by Dappros Ltd, UK) or one of its official distributor partners.
You should remove the COPYING and LICENSE files in such case if you have your local copy duplicated from the main Ethora repository, as your code is governed by custom license terms.