Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Custom issue template
about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''

---


20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
File renamed without changes.
18 changes: 18 additions & 0 deletions .github/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
> 🧭 **Note:** This issue template is a draft — — feel free to
[suggest improvements](https://github.com/${ORG}/.github/edit/main/ISSUE_TEMPLATE/bug_report.md)
via PR to the `.github` repository.

---
name: Feature request
about: Suggest an idea for the project
title: ''
labels: enhancement
assignees: ''

---

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear description of any alternative solutions or features you've considered.
12 changes: 12 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"MD013": {
"line_length": 120
},
"MD022": {
"lines_above": 1,
"lines_below": 0
},
"MD032":false,
"MD041": false,
"default": true
}
36 changes: 36 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
> **Status:** Draft — open to feedback and improvement.
> This document will evolve as our community grows.
>
> 💡 Welcome [to propose an edit](../edit/main/CODE_OF_CONDUCT.md)
via PR to the `.github` repository.

# Code of Conduct

## Our Pledge
We as members, contributors, and leaders pledge to make participation in our community
a harassment-free experience for everyone, regardless of age, body size,
visible or invisible disability, ethnicity, gender identity,
level of experience, nationality, personal appearance, race, religion, or sexual identity.

## Our Standards
Examples of positive behavior:
- Being respectful and welcoming
- Giving and gracefully accepting feedback
- Focusing on what is best for the community

Unacceptable behavior includes:
- Harassment, insults, or derogatory comments
- Publishing others' private information
- Any conduct that could reasonably be considered inappropriate

## Enforcement
Project maintainers are responsible for clarifying and enforcing standards.
Unacceptable behavior may result in removal from community spaces or projects.

## Scope
This Code applies within all organization spaces and in public spaces
when representing our projects or community.

## Attribution
This Code of Conduct is adapted from
the [Contributor Covenant](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html).
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
> **Status:** Draft — open to feedback and improvement.
> 💡 Welcome to [suggest a change](../edit/main/CONTRIBUTING.md)
via PR to the `.github` repository.

# Contributing to the Organization Projects

We welcome contributions to any of our projects. To ensure smooth collaboration:

- Fork the repository and create a feature branch.
- Follow the existing coding style.
- Open a PR with a clear description and linked issue (if any).
- Ensure tests pass before submission.
- Respect our [Code of Conduct](CODE_OF_CONDUCT.md).

Thank you for helping us improve!
18 changes: 18 additions & 0 deletions PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
> 🧭 **Note:** This PR template is a draft — feel free to
[suggest improvements](https://github.com/${ORG}/.github/edit/main/PULL_REQUEST_TEMPLATE.md)
via PR to the `.github` repository.

## Description

Please include a summary of the changes and the related issue.

## Type of change
- [ ] Bug fix
- [ ] New feature
- [ ] Documentation update
- [ ] Other

## Checklist
- [ ] My code follows the style guidelines of this project.
- [ ] I have performed a self-review of my code.
- [ ] I have commented on any hard-to-understand areas.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Meta repository of `localcompose`

> 🧩 **Note:**
> The policies and templates in this `.github` repository are **drafts**.
> They are expected to evolve as our organization and projects (like *locom* and *fastreleaser*) mature.
> Suggestions and pull requests to improve them are **warmly welcome** — please open an
[issue](https://github.com/localcompose/.github/issues/new)
or [PR](../../edit/main/profile/README.md) in this repository.
40 changes: 31 additions & 9 deletions profile/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,41 @@
# 🚧 localcompose
> **Status:** 🚧 Draft — open to feedback and improvement.
> This document will evolve as our community grows.

## localcompose
# localcompose

**localcompose** is a tool for running local Docker Compose apps in an offline-friendly, no-cloud-required way.
It helps you stop juggling ports and IPs like `127.0.0.1:9000`, giving each app a clean domain name and a trusted HTTPS link.
With minimal setup, your local tools feel like real websites — easier to browse, test, and connect across your system.
**localcompose** is a tool for running local Docker Compose apps in an offline-friendly,
no-cloud-required way.
It helps you stop juggling ports and IPs like `127.0.0.1:9000`,
giving each app a clean domain name and a trusted HTTPS link.
With minimal setup, your local tools feel like real websites —
easier to browse, test, and connect across your system.

For example, you can turn `http://localhost:9000/` into `https://portainer.locom.self` — no cloud, no port hassle, just localhost done right.
For example, you can turn `http://localhost:9000/` into `https://portainer.locom.self` —
no cloud, no port hassle, just localhost done right.

🔧 Current focus:
We are actively developing `locom`, a command-line tool to orchestrate local-only Docker Compose workflows with simplicity and clarity.
We are actively developing `locom`,
a command-line tool to orchestrate local-only Docker Compose workflows with simplicity and clarity.

💡 Vision:
Support developers, testers, and tinkerers who prefer local, private, and reliable environments — without unnecessary cloud complexity. See [strategic pyramid](../docs/strategic-pyramid.md) for visualization.
Support developers, testers, and tinkerers who prefer local, private, and reliable environments —
without unnecessary cloud complexity.
See [strategic pyramid](../docs/strategic-pyramid.md) for visualization.

---

📌 _This project is in active development. Contributors and feedback are welcome. Please watch [the repo](https://github.com/localcompose/locom) for updates!_
📌 _This project is in active development. Contributors and feedback are welcome.
Please watch [the repo](https://github.com/localcompose/locom) for updates!_

---

> 🧩 **Note:**
> The policies and templates in this `.github` repository are **drafts**.
> They are expected to evolve as our organization and projects
(like [_`locom`_](https://github.com/localcompose/locom) and [_`fastreleaser`_](https://github.com/localcompose/fastreleaser))
mature.
> Suggestions and pull requests to improve them are **warmly welcome** — please open an
[issue](https://github.com/localcompose/.github/issues/new)
or [PR](https://github.com/localcompose/.github/edit/main/profile/README.md) in this repository.
>
> See also: [Meta repository of `localcompose` organization](https://github.com/localcompose/.github)