Contributing

Getting started

Reporting Security Issues

  • Please report security issues directly to us at support@….

Reporting Bugs

Before reporting a bug, please read these simple guidelines:

  • Search first: Make sure the bug hasn't already been reported.
  • Be complete: Write complete, reproducible, specific bug reports. Include as much information as you possibly can, complete with code snippets, test cases, etc. This means including a clear, concise description of the problem, and a clear set of instructions for replicating the problem. A minimal example that illustrates the bug in a nice small test case is the best possible bug report.
  • Fill in as many fields as possible, and file it under type 'defect'.

Once you're ready, report it!

Requesting Features

Before requesting a feature, please read these simple guidelines:

  • Search first: Make sure the feature hasn't already been requested.
  • Be complete: Write a clear and full description of the feature that you are requesting.
  • If you are not sure about whether it is a valid request, add a message to the  epresence-developers mailing list, to discuss it with the primary developers.
  • Fill in as many fields as possible, and file it under Milestone Feature Requests/ePresence 5.0+, and type 'defect'.

Once you're ready, file it!

Getting the code

To get the latest version from our repository, check out using Subversion:

svn co https://epresence.svn.sourceforge.net/svnroot/epresence epresence 

Ticket triage

Primary developers will sort tickets into a number of different "triage steps" depending on its review stage. All tickets not added by primary developers should first be added as "Unreviewed" (the default).

  • Unreviewed: The ticket has not yet been reviewed by a primary developer.
  • Design Decision Needed: The ticket has been reviewed, and a design decision is required. This discussion may take place on the  epresence-developers mailing list if it involves community developers.
  • Accepted: The ticket has been accepted. Work should commence based on the design decisions that were made in the previous stage.

Submitting Patches

  • Submit patches in the format returned by the svn diff command. An exception is for code changes that are described more clearly in plain English than in code.
  • Patches should be attached to the relevant ticket in the tracker using the 'Attach File' feature.
  • Name the patch file with a .diff extension; this will let the ticket tracker apply correct syntax highlighting, which is quite helpful.
  • Check the “Has patch” box on the ticket details. This will make it obvious that the ticket includes a patch, and it will add the ticket to the list of tickets with patches.
  • If the patch contains code implementing new features/enhancements, it should be accompanied by relevant documentation.