CONTRIBUTING.md

Contributing to One Concept

One Concept is a small, single-team, source-available project. The code is here to read, learn from, run, and share.

The best way to help: open an issue

Feedback, bug reports, and feature suggestions are genuinely welcome and are the best way to shape the project. Search existing issues first, then include a clear title, what happened vs. what you expected, and steps to reproduce for bugs. → https://github.com/Coding-Moves/one-concept/issues

Using the code

Under the MIT License you're free to use, run locally, modify, and redistribute it. See backend/README.md and mobile/DEPLOYMENT.md to run it yourself.

Code changes

We build this as a small team and develop in the open, so we don't generally take outside pull requests — issues are the place to contribute. If something really needs a code change, open an issue first and we'll take it from there.

Before opening a pull request, run the checks for the area you changed:

# Mobile (Node 24)
cd mobile
npm ci
npm run typecheck
npm test

# Backend (Python 3.12; Podman starts a disposable PostgreSQL 16 database)
cd backend
python -m venv .venv
.venv/bin/pip install -r requirements-dev.txt ruff
.venv/bin/ruff check --select F,E9 .
.venv/bin/python -m pytest

Pull requests into develop and main run these same application gates in GitHub Actions. The backend suite skips its database cases when Podman is unavailable locally; the PR gate treats a skip as a failure so its PostgreSQL coverage is always exercised before merge.

License

The project is licensed under the MIT License.

Maintainer pull requests

When a maintainer pull request fully resolves one existing issue, its description must include Fixes #<issue-number> or Closes #<issue-number>. This makes the issue close automatically when the pull request is merged and keeps the work traceable. Do not use a closing keyword for partial work or a related issue that remains open.