Skip to content

Commit ca2d44b

Browse files
Merge pull request #274 from sassoftware/PSKD-1726
chore(gcp): Add the community features READMEs
2 parents e176223 + 6649f2b commit ca2d44b

File tree

2 files changed

+51
-0
lines changed

2 files changed

+51
-0
lines changed

docs/community/README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Community-Contributed Features
2+
3+
Community contributed features are submitted by community members to help expand the set of features that the project maintainers are capable of adding to the project on their own.
4+
5+
> [!CAUTION]
6+
> Community members are responsible for maintaining these features. While project maintainers try to verify these features work as expected when merged, they cannot guarantee future releases will not break them. If you encounter issues while using these features, start a [GitHub Discussion](https://github.com/sassoftware/viya4-iac-gcp/discussions) or open a Pull Request to fix them. As a last resort, create a GitHub Issue for the concern.
7+
8+
# Community-Contributed Feature Expectations
9+
10+
- As with other features, community contributed features should include unit tests which add to the level of community confidence for the feature. Unit tests should also help indicate if a problem occurs with the feature in a future release.
11+
12+
- Community contributed features should be disabled by default. If applicable, a boolean configuration variable named community_enable_<community_feature> should be implemented for the community feature. The boolean configuration variable should serve as a way to enable or disable the community feature.
13+
14+
- Multiple community contributed feature configuration variables may exist for the same feature, although if the feature is disabled, they should have no effect on the overall behavior of the project.
15+
16+
- Additional community contributed feature configuration variables should use the community_ prefix to indicate they are part of a community contributed feature.
17+
18+
# Submitting a Community-Contributed Feature
19+
20+
Submit a community contributed Feature by creating a GitHub PR in this project. The PR should include the source code, unit tests and any required documentation including expected content for the [docs/community/community-config-vars.md](community-config-vars.md) file.
21+
22+
# What if a Community-Contributed Feature breaks
23+
24+
If you encounter issues while using a community contributed feature, start a [GitHub Discussion](https://github.com/sassoftware/viya4-iac-gcp/discussions) or open a Pull Request to fix the issue. As a last resort, you can create a GitHub Issue to inform the community about the problem.
25+
26+
If a community contributed feature is implemented as required, disabling the community feature should serve as a way to remove any impact that it has on the project. Community contributed features that affect the project when disabled should be re-worked to prevent that behavior.
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Community-Contributed Configuration Variables
2+
3+
Community contributed configuration variables are listed in the tables below. These variables can also be specified on the terraform command line.
4+
5+
> [!CAUTION]
6+
> Community members are responsible for maintaining these features. While project maintainers try to verify these features work as expected when merged, they cannot guarantee future releases will not break them. If you encounter issues while using these features, start a [GitHub Discussion](https://github.com/sassoftware/viya4-iac-gcp/discussions) or open a Pull Request to fix them. As a last resort, you can create a GitHub Issue.
7+
8+
**Instructions for use**: Replace the Community Feature TOC entry and section name with your new Community Feature name. Include information about the feature. Include any warnings and a table documenting the associated community contributed configuration variables by replacing each placeholder below with the information relevant to your community contributed feature.
9+
10+
## Table of Contents
11+
12+
* [Community Feature](#community_feature)
13+
14+
<a name="community_feature"></a>
15+
## Community Feature
16+
17+
Here is some information about Community Feature.
18+
19+
Here is a warning about why it might cause issues.
20+
21+
Here is a table with the variables you would use to configure it
22+
23+
| Name | Description | Type | Default | Release Added | Notes |
24+
| :--- | ---: | ---: | ---: | ---: | ---: |
25+
| community_enable_community_feature | Enable community feature | bool | false | vMajor.Minor.Patch | |

0 commit comments

Comments
 (0)