diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..9d41ca3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,35 @@ +# Contributing to Codegenie open source + +Thank you for contributing. Repository-specific documentation and contribution rules take precedence over this organization default. + +## Before starting + +- Search existing issues and pull requests to avoid duplicate work. +- Open an issue before a large, breaking or architecture-changing proposal. +- Keep changes focused on a demonstrated bug, risk or maintainability improvement. +- Do not add dependencies, abstractions or infrastructure without clear value. + +## Development expectations + +- Preserve documented public APIs unless a breaking change is explicitly accepted. +- Follow the repository's existing language, framework and formatting conventions. +- Add or update regression tests for behavior changes and risk-sensitive fixes. +- Update documentation and release notes when users need to know about the change. +- Run every validation command documented by the repository. +- Never commit secrets, credentials, personal data, production logs or customer data. + +## Pull requests + +A pull request should explain: + +- the problem and its impact; +- the chosen solution and why it is appropriately small; +- tests and validation performed; +- compatibility, security, privacy and upgrade implications; +- any remaining limitations or follow-up work. + +Keep unrelated refactors out of the same pull request. Maintainers may ask for a smaller scope when that improves reviewability or release safety. + +## Security reports + +Do not disclose suspected vulnerabilities in a public issue or pull request. Follow `SECURITY.md` instead. diff --git a/README.md b/README.md index 0d82c37..9e2ee13 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,10 @@ -# .github -Codegenie-BE organization profile +# Codegenie-BE organization configuration + +This repository contains the public Codegenie organization profile and default community health files used by repositories that do not provide their own versions. + +- `profile/README.md`: public organization profile +- `CONTRIBUTING.md`: default contribution expectations +- `SECURITY.md`: private vulnerability reporting policy +- `SUPPORT.md`: support and issue-routing guidance + +Repository-specific files take precedence over these defaults. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..28edb14 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,27 @@ +# Security policy + +Security reports are handled privately and should never be opened as public issues. + +## Reporting a vulnerability + +Use GitHub private vulnerability reporting from the affected repository's **Security** tab when it is available. Otherwise, email `info@codegenie.be` with: + +- the affected repository and version or commit; +- a concise description of the impact; +- reproducible steps or a minimal proof of concept; +- relevant environment details; +- any suggested mitigation, when known. + +Do not include production credentials, access tokens, personal data, customer data or private logs unless an encrypted exchange has been agreed first. + +## Response and disclosure + +Codegenie will validate the report, determine affected versions and coordinate a fix and disclosure appropriate to the risk. Please allow a reasonable remediation period before publishing details that could put users at risk. + +## Supported versions + +Support windows differ by project. Check the affected repository's README, release notes and dependency constraints. When practical, reproduce the issue on the latest stable release before reporting it. + +## Non-security issues + +General bugs, feature requests and documentation corrections belong in the affected repository's public issue tracker and must not contain secrets or personal data. diff --git a/SUPPORT.md b/SUPPORT.md new file mode 100644 index 0000000..12c8648 --- /dev/null +++ b/SUPPORT.md @@ -0,0 +1,26 @@ +# Support + +Choose the channel that matches the request so it can be handled safely and efficiently. + +## Open-source bugs and feature requests + +Use the issue tracker of the affected repository. Include the package or plugin version, runtime and framework versions, minimal reproduction steps, expected behavior and actual behavior. + +Before opening an issue: + +- check the repository README and release notes; +- search existing issues and pull requests; +- reproduce the problem on the latest compatible stable release when practical; +- remove secrets, personal data and private customer information from logs and examples. + +## Security vulnerabilities + +Do not use a public issue. Follow the organization `SECURITY.md` and use GitHub private vulnerability reporting when available. + +## Codegenie products and commercial support + +Questions about Codegenie services, hosted products, accounts or private projects are not handled through public open-source issues. Use the contact channel published on the Codegenie website or email `info@codegenie.be`. + +## Scope + +Open-source maintenance is provided on a reasonable-effort basis. Response times and long-term support windows differ by repository and are documented per project where applicable. diff --git a/profile/README.md b/profile/README.md index fcd0490..76e1c3d 100644 --- a/profile/README.md +++ b/profile/README.md @@ -2,7 +2,7 @@ Codegenie builds maintainable Laravel applications, API integrations and reusable open-source tools. -Our work focuses on reliable backend architecture, clear business workflows, automated testing, security and predictable deployments. Public repositories are developed from recurring technical problems encountered in real Laravel projects. +Our work focuses on reliable backend architecture, clear business workflows, automated testing, security and predictable deployments. Public repositories are developed from recurring technical problems encountered in real Laravel and web projects. ## Open-source projects @@ -11,6 +11,7 @@ Our work focuses on reliable backend architecture, clear business workflows, aut - [Laravel Transaction Guard](https://github.com/Codegenie-BE/laravel-transaction-guard), make transaction boundaries and failure handling more explicit - [Laravel Livewire Multistep Form](https://github.com/Codegenie-BE/laravel-livewire-multistep-form), build maintainable multistep form workflows - [Codegenie Pulse WordPress Connector](https://github.com/Codegenie-BE/codegenie-pulse-connector-wordpress), connect WordPress installations to website monitoring workflows +- [cg-aos](https://github.com/Codegenie-BE/cg-aos), add dependency-free animate-on-scroll behavior to frontend projects ## Work with Codegenie