Contributing Back

Some customizations are specific to your factory. Others are things every garment factory needs, and those are worth sending back to us — so they arrive in the next update, tested and maintained, instead of being yours to carry forever.

What is worth contributing

Yes: a bug with clear steps to reproduce, a missing field that any factory would want, a translation, a correction to these docs, a report that isn't specific to your business.

Probably not: anything encoding your own process, naming or customer list. That is what customization is for, and keeping it on your site is the right outcome.

Reporting something

Open an issue on the repository with:

  1. What you did — the exact steps.
  2. What you expected.
  3. What happened, including the exact error text.
  4. Where — Desk or which app, and which version.
  5. A screenshot if it is visual.

The version is on Help → About in Desk. Include it; behaviour differs between releases.

For a broken document, the Error Log entry (Awesome Bar → error log) is the single most useful thing you can attach.

Sending a change

The project follows normal GitHub practice: fork, branch, commit, pull request.

  • One change per pull request. A PR doing three things takes three times as long to review and gets rejected as a whole.
  • Say why in the description, not just what. The problem it solves is what a reviewer needs.
  • Match the surrounding code. Python is formatted with ruff at 110 columns, tabs for indentation. Run the project's pre-commit hooks before pushing.
  • Include a test for anything with logic. Tests use Frappe's IntegrationTestCase.
  • Never commit credentials, site config or customer data.

Documentation

These pages live in docs/<lang>/ in the repository and publish automatically when merged.

To fix something: edit the Markdown file, and if you added a page, add it to docs/<lang>/SUMMARY.md. Documentation-only pull requests are welcome and are the easiest kind to get merged.

Two house rules: never put cost or margin figures in public documentation or screenshots, and call the mobile applications "App", not "PWA".

What to do next

Back to Extending GarmentFlow.

More in Extend & Integrate

WhatsApp