Skip to content

feat: add contributing guide and generator readme - #73

Closed
kriscoleman wants to merge 1 commit into
open-feature:refactor-manifestfrom
kriscoleman:codegen/documentation
Closed

feat: add contributing guide and generator readme#73
kriscoleman wants to merge 1 commit into
open-feature:refactor-manifestfrom
kriscoleman:codegen/documentation

Conversation

@kriscoleman

@kriscoleman kriscoleman commented Mar 10, 2025

Copy link
Copy Markdown
Collaborator

This PR

Added a new CONTRIBUTING.md file with detailed instructions on how to contribute new generators to the project. This includes steps from forking the repository, implementing the generator logic, writing tests, registering the generator in CLI, updating documentation, and creating a pull request.

Also added a README.md in the internal/generators directory explaining how each generator works. It details about language.go and language.tmpl files that are essential parts of each generator along with an example workflow of how these components interact to generate code based on OpenFeature flag manifest.

Related Issues

closes #69

Notes

  • this PR is on top of @beeme1mr 's current WIP branch, and assumes that refactor comes before this.
  • @beeme1mr mentioned he made some doc updates too, so it's possible there could be merge conflicts. I'm happy to help resolve any.

@beeme1mr beeme1mr left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! This looks great.

@kriscoleman

Copy link
Copy Markdown
Collaborator Author

@beeme1mr thanks for approval!

I rebased on your branch to resolve conflicts and fixed the sign off

Added a new CONTRIBUTING.md file with detailed instructions on how to contribute new generators to the project. This includes steps from forking the repository, implementing the generator logic, writing tests, registering the generator in CLI, updating documentation, and creating a pull request.

Also added a README.md in the internal/generators directory explaining how each generator works. It details about `language.go` and `language.tmpl` files that are essential parts of each generator along with an example workflow of how these components interact to generate code based on OpenFeature flag manifest.

Signed-off-by: Kris Coleman <kriscodeman@gmail.com>
@kriscoleman
kriscoleman force-pushed the codegen/documentation branch from ce40712 to 7324e24 Compare March 13, 2025 14:45
@beeme1mr
beeme1mr deleted the branch open-feature:refactor-manifest March 14, 2025 20:12
@beeme1mr beeme1mr closed this Mar 14, 2025
@beeme1mr

Copy link
Copy Markdown
Member

@kriscoleman no idea why this was closed. Sorry about that! Could you please reopen it when you have moment?

jonathannorris added a commit that referenced this pull request Aug 17, 2026
- @angular/core 20.3.25 -> 20.3.28 (high, alert #75: XSS via event-handler attributes)
- @angular/compiler 20.3.25 -> 20.3.28 (high, alert #74: XSS via event-handler attributes)
- @angular/common 20.3.25 -> 20.3.28 (high, alert #73: cache-key ambiguity in HttpTransferCache)
- brace-expansion 2.1.0 -> 2.1.4 (high, alert #72: DoS via exponential-time expansion)

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
jonathannorris added a commit that referenced this pull request Aug 17, 2026
* chore: resolve open dependabot security alerts

- vite ^6.4.2 -> ^6.4.3 (medium/high, alerts #57 #58)
- @babel/core transitive -> ^7.29.6 via override (low, alert #56)
- @angular/common, @angular/core, @angular/compiler 19.x -> 20.3.25 (high/medium, alerts #52 #53 #54 #55)

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

* chore: align @openfeature/web-sdk with angular-sdk peer dependency

Address Copilot review feedback on PR #253: @openfeature/angular-sdk
1.3.1 requires @openfeature/web-sdk ^1.9.0 as a peer dependency, but
package.json still allowed ^1.7.3. Bump the declared range to match
and regenerate the lockfile.

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

* chore: resolve additional dependabot alerts for fast-uri

- fast-uri ^3.1.2 -> ^3.1.4 (high, alert #59: host confusion via failed IDN canonicalization)
- fast-uri ^3.1.2 -> ^3.1.4 (high, alert #60: host confusion via literal backslash authority delimiter)

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

* fix(deps): regenerate OpenAPI client for oapi-codegen v2.8.0

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

* chore: resolve postcss alert and pin fast-uri exactly

- postcss <= 8.5.17 -> ^8.5.18 override (high, alert #62)
- pin fast-uri override to exact 3.1.4 per CodeRabbit review suggestion

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

* chore: bump fast-uri to 3.1.5 for dependabot alert #64

- fast-uri 3.1.4 -> 3.1.5 (high, alert #64: host confusion via backslash authority introducer)

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

* chore: resolve open dependabot security alerts

- @angular/core 20.3.25 -> 20.3.28 (high, alert #75: XSS via event-handler attributes)
- @angular/compiler 20.3.25 -> 20.3.28 (high, alert #74: XSS via event-handler attributes)
- @angular/common 20.3.25 -> 20.3.28 (high, alert #73: cache-key ambiguity in HttpTransferCache)
- brace-expansion 2.1.0 -> 2.1.4 (high, alert #72: DoS via exponential-time expansion)

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>

---------

Signed-off-by: Jonathan Norris <jonathan.norris@dynatrace.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants