Skip to content

Commit

Permalink
recommend adding a keyword to the metadata (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
dirk-thomas committed Apr 30, 2018
1 parent 3db3b67 commit 2dba10b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions developer/contribution.rst
Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,14 @@ New packages / extensions
Using Python entry points it is easy to contribute extensions in separate packages.
To ease discoverability and ensure long term maintenance if individual maintainers move on it is encouraged to host the code in a repository under the `colcon` organization unit on GitHub.
Please open a ticket to either ask for the creation of a repository which you will have `admin` level access to or for moving an existing repository to this organization unit.

Use keyword in package metadata
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When creating a package containing ``colcon`` extensions please consider declaring a keyword to help discovering extensions through e.g. PyPI.
When using a ``setup.cfg`` file for the metadata of the package it is as simple as including these lines:

.. code-block:: ini
[metadata]
keywords = colcon

0 comments on commit 2dba10b

Please sign in to comment.