-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #825 from entando/ENDOC-802
ENDOC-802 community docs updates
- Loading branch information
Showing
4 changed files
with
52 additions
and
64 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,56 @@ | ||
|
||
# Contributing to Entando | ||
|
||
There are many ways to contribute to Entando including participating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, [updating documentation](https://github.com/entando/entando-docs/tree/master/vuepress), building bundles using the [Local Hub](../compose/local-hub-overview.md), and contributing directly to the source. | ||
Welcome to the Entando community. There are many ways to participate in the community, including collaborating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, improving the [documentation](https://github.com/entando/entando-docs/tree/master/vuepress), [building bundles](../../tutorials/create/pb/publish-simple-bundle.md), or contributing directly to the source. Connect and share with other like-minded developers and become part of a learning, growing community. | ||
|
||
## Contributing to the Source | ||
|
||
Entando welcomes contributions to our source code repositories. This is a brief overview of how to create a pull request for an Entando repository. | ||
|
||
If you're new to forks in the git world checkout this guide [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks) | ||
If you're new to forks in the Git world, checkout this guide, [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks). | ||
|
||
1. Find the repository you want to edit on the Entando GitHub | ||
1. Find the repository you want to edit on the Entando GitHub. | ||
* <https://github.com/entando> | ||
* <https://github.com/entando-k8s> | ||
2. Create a fork of the repository you want to update | ||
3. Make your changes or updates on your fork. We recommend making your changes on a branch so that you can update your commits as needed before creating your PR | ||
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue reference that issue number in the notes and linked issues | ||
5. Watch the automated builds to make sure everything passes | ||
6. The Entando team will merge your changes! | ||
|
||
2. Create a fork of the repository you want to update. | ||
3. Make the changes or improvements on your fork. We recommend making the changes on a branch so that you can update your commits as needed before creating the PR. | ||
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue, reference that issue number in the notes and linked issues. | ||
5. Watch the automated builds to make sure everything passes. | ||
6. The Entando team will merge your pull request upon review! | ||
|
||
## Code Style and Formatting | ||
Most Entando repositories enforce code style rules. References and setup for the main | ||
source types are provided below. | ||
|
||
### Java | ||
Java rules are based on checkstyle and PMD can be found at in the [entando-code-style]( | ||
Java rules based on Checkstyle and PMD can be found in the [entando-code-style]( | ||
https://github.com/entando/entando-code-style) project. There are configuration files for Intellij, Eclipse, and Netbeans for automated formatting. | ||
|
||
### Javascript | ||
|
||
Code style and formatting rules for all Entando javascript projects are enforced by linters in every project. For a reference example see: .sass-lint.yml and .eslintrc.js in the [App builder](https://github.com/entando/app-builder) | ||
Code style and formatting rules for all Entando Javascript projects are enforced by linters in every project. For a reference example see: `.sass-lint.yml` and `.eslintrc.js` in the [App builder](https://github.com/entando/app-builder) | ||
|
||
In the future these rules will be replaced by Prettier. | ||
In the future these rules will be replaced by Prettier. <!-- Should this line be removed? --> | ||
|
||
### Find the Code | ||
|
||
Entando source can be found on GitHub in the following organizations. | ||
* <https://github.com/entando> | ||
* <https://github.com/entando-k8s> | ||
|
||
For an overview of the key projects in both GitHub organizations and their role in the architecture see [Entando Deployment Structure](../reference/deployment-structure.md) | ||
For an overview of the key projects in both GitHub organizations and their role in the architecture, see the [Entando Deployment Structure](../reference/deployment-structure.md) | ||
|
||
## Get Help | ||
|
||
If you have questions, need help, or want to find out more about contributing join us at | ||
If you have questions, need help, or want to find out more about contributing, join us at: | ||
|
||
- [Entando Forum](https://forum.entando.com) | ||
- [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw) | ||
|
||
## Licenses | ||
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The entando-docs repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information. | ||
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The `entando-docs` repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information. | ||
|
||
Entando libraries licensed with LGPL V3.0 that are used to build applications may be linked to proprietary applications. If linked statically, the application code must also be released as LGPL. If the application is linked dynamically to Entando, the proprietary code does not need to be released. | ||
|
||
A commercial open source license is provided for the Entando Platform for customers with Gold and Platinum subscriptions. This license permits freely extending or modifying Entando without requiring contribution of confidential IP back to the open source community. | ||
A commercial open source license is provided for customers of the Entando Platform with Gold and Platinum subscriptions. This license permits freely extending or modifying the Platform without requiring the confidential intellectual property (IP) to be returned to the open source community. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,56 +1,57 @@ | ||
|
||
|
||
# Contributing to Entando | ||
|
||
There are many ways to contribute to Entando including participating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, [updating documentation](https://github.com/entando/entando-docs/tree/master/vuepress), building bundles using the [Local Hub](../compose/local-hub-overview.md), and contributing directly to the source. | ||
Welcome to the Entando community. There are many ways to participate in the community, including collaborating in the [Entando Forum](https://forum.entando.com), opening issues on GitHub, improving the [documentation](https://github.com/entando/entando-docs/tree/master/vuepress), [building bundles](../../tutorials/create/pb/publish-simple-bundle.md), or contributing directly to the source. Connect and share with other like-minded developers and become part of a learning, growing community. | ||
|
||
## Contributing to the Source | ||
|
||
Entando welcomes contributions to our source code repositories. This is a brief overview of how to create a pull request for an Entando repository. | ||
|
||
If you're new to forks in the git world checkout this guide [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks) | ||
If you're new to forks in the Git world, checkout this guide, [Working with Forks](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/working-with-forks). | ||
|
||
1. Find the repository you want to edit on the Entando GitHub | ||
1. Find the repository you want to edit on the Entando GitHub. | ||
* <https://github.com/entando> | ||
* <https://github.com/entando-k8s> | ||
2. Create a fork of the repository you want to update | ||
3. Make your changes or updates on your fork. We recommend making your changes on a branch so that you can update your commits as needed before creating your PR | ||
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue reference that issue number in the notes and linked issues | ||
5. Watch the automated builds to make sure everything passes | ||
6. The Entando team will merge your changes! | ||
|
||
2. Create a fork of the repository you want to update. | ||
3. Make the changes or improvements on your fork. We recommend making the changes on a branch so that you can update your commits as needed before creating the PR. | ||
4. Submit a PR against the main (or master) branch of the repository you're working against. If you're fixing a specific issue, reference that issue number in the notes and linked issues. | ||
5. Watch the automated builds to make sure everything passes. | ||
6. The Entando team will merge your pull request upon review! | ||
|
||
## Code Style and Formatting | ||
Most Entando repositories enforce code style rules. References and setup for the main | ||
source types are provided below. | ||
|
||
### Java | ||
Java rules are based on checkstyle and PMD can be found at in the [entando-code-style]( | ||
Java rules based on Checkstyle and PMD can be found in the [entando-code-style]( | ||
https://github.com/entando/entando-code-style) project. There are configuration files for Intellij, Eclipse, and Netbeans for automated formatting. | ||
|
||
### Javascript | ||
|
||
Code style and formatting rules for all Entando javascript projects are enforced by linters in every project. For a reference example see: .sass-lint.yml and .eslintrc.js in the [App builder](https://github.com/entando/app-builder) | ||
Code style and formatting rules for all Entando Javascript projects are enforced by linters in every project. For a reference example see: `.sass-lint.yml` and `.eslintrc.js` in the [App builder](https://github.com/entando/app-builder) | ||
|
||
In the future these rules will be replaced by Prettier. | ||
In the future these rules will be replaced by Prettier. <!-- Should this line be removed? --> | ||
|
||
### Find the Code | ||
|
||
Entando source can be found on GitHub in the following organizations. | ||
* <https://github.com/entando> | ||
* <https://github.com/entando-k8s> | ||
|
||
For an overview of the key projects in both GitHub organizations and their role in the architecture see [Entando Deployment Structure](../reference/deployment-structure.md) | ||
For an overview of the key projects in both GitHub organizations and their role in the architecture, see the [Entando Deployment Structure](../reference/deployment-structure.md) | ||
|
||
## Get Help | ||
|
||
If you have questions, need help, or want to find out more about contributing join us at | ||
If you have questions, need help, or want to find out more about contributing, join us at: | ||
|
||
- [Entando Forum](https://forum.entando.com) | ||
- [Community Slack](https://join.slack.com/t/entandocommunity/shared_invite/zt-g609owdv-2K~YRh8zrI6lqlWo4aFWUw) | ||
|
||
## Licenses | ||
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The entando-docs repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information. | ||
The Entando Platform is 100% open source and most Entando repositories are licensed under the LGPL V3.0. The `entando-docs` repository is one exception with a [CC BY 4.0 license](https://github.com/entando/entando-docs/blob/main/LICENSE). See the LICENSE file in the root directory of a given repository for its specific license information. | ||
|
||
Entando libraries licensed with LGPL V3.0 that are used to build applications may be linked to proprietary applications. If linked statically, the application code must also be released as LGPL. If the application is linked dynamically to Entando, the proprietary code does not need to be released. | ||
|
||
A commercial open source license is provided for the Entando Platform for customers with Gold and Platinum subscriptions. This license permits freely extending or modifying Entando without requiring contribution of confidential IP back to the open source community. | ||
A commercial open source license is provided for customers of the Entando Platform with Gold and Platinum subscriptions. This license permits freely extending or modifying the Platform without requiring the confidential intellectual property (IP) to be returned to the open source community. | ||
|