Contributing

From ESL
Revision as of 17:10, 9 August 2014 by Eartacho (talk | contribs)
Jump to navigation Jump to search

Contributions from the community are encouraged. If you have a piece of software or a proposal for an API or a data standard that you think would be a good addition to the ESL, here are the steps to follow:

  1. Login or create an ESL wiki account
  2. Create a new page on the ESL wiki:

    OR


  3. Good luck!

A bit more information...

First of all, read About ESL for an introduction to the six possible categories for ESL entries. Have a look around the existing entries to get a feel for how the division in categories works in practice. Also look at our dummy pages for Software, APIs, and Functionalities.

Then, ask yourself a few questions:

  • What kind of entry is right for my contribution? What categories should it contain?
  • Do I want to create and maintain the wiki entry personally? This is the preferred option, and is not a difficult task. If not, contact us to find out if one of our contributors is interested in doing so.
  • If the entry contains a piece of software, how will the code be maintained and linked to the ESL? You can opt for an external repository/website, a mirrored repository, or an internal development. For the last two options, please read about Getting started with Launchpad and Working with Launchpad.

We remind you to pay special attention to the category tags at the end of your page. All entries should contain at least two mandatory tags:

  • ESL entries
  • All that apply from: Functionalities, Algorithms, Generic interfaces, APIs, Data standards, Software

You will see that existing entries also contain other tags, categorising them into themes. For the moment, these are maintained by the ESL Curating Team, and so you do not need to worry about adding them.

If what you are doing involves more than documenting in the wiki (e.g. coding for ESL, or linking something from ESL into some program), or you are embarked in a significant documentation project (e.g. data standards), please, do enter a bullet point in the list in the ESL activities page.

Finally, reward yourself for all the hard work by adding your name to the Credits page.