Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Note

Our Subversion server is deprecated in favor of using Git and GitHub to store code going forward. This page remains here for legacy projects and historical accuracy.

See GitHub Conventions for the updated version

Why have this document?

Our Subversion repository (view) is wonderful in many ways. To keep it wonderful, committers should follow a few simple guidelines.

...

The code in custom-builds is up to the specific contributor, but and is not for developing, see custom-builds

Info

See also: Subversion Repository Layout

...

  • Admin Committers
    • Able to commit to the /trunk/tags folder
    • Only used during a release cycle. The role of the admin(s) at this time is to tag the trunk code, generate the war file, update the install file, and post (release) the files.
    • The current admins are anyone who has served as a release manager: ~bwolfe Ben Wolfe, ~darius Darius Jazayeri, and ~wyclif Wyclif Luyima
  • Full Committers (mostly core devs)
    • May commit to any part of the subversion tree
    • May commit patches to trunk by outside developers
    • May create a branch for themselves or partial committers (see #Creating a branch for commit comment examples)
    • Can request a partial committer be promoted to a full committer.

...

Anyone can become a partial committer.  Email code at openmrs.org and request access for a module or branch.  See committer subversion access for details on how to request repository access and what to include in your request.

...

We welcome outside developers to become partial access committers. For outside developers that would like to contribute something larger than a bug fix, a branch can be created and read/write access given to that developer. If you would like to have a branch created for you see Developers Guide /wiki/spaces/AR/pages/18514002

Modules

All module code will be placed under the /openmrs-modules folder in the repository. The name of the folder for the source code will be the name of the module id. The code stored in the repository must be open source, but does not have to be under the OPL. See also Module Licensing

...

Module authors are encouraged to mimic the OpenMRS versioning style: major.minor.maintenance – e.g., 1.5.2.

...

To request space for a new module see requesting a module/project of the Code Repository page.

Source code for forgotten, no longer supported, and/or abandoned modules may be moved to the /openmrs-modules/abandoned/ folder.

...

  • Be as specific as possible in your initial commit comment. Commits creating new branches are sent to the developers mailing list.
  • Be sure to include the branch name and if applicable, the username of its intended user
  • For partial committers, include the username of the approving full committer
  • For branches based on tickets, put ticket number in branch name
Info

See requesting subversion repository access /wiki/spaces/AR/pages/18514002 for how to request a new branch.

...