Skip to content

Feature Request writing Guidelines

tfr42 edited this page Mar 13, 2021 · 13 revisions

Principles

  • Check if an similar feature request is already open, see the list of open feature requests.
  • Please specify one feature request per ticket!
  • Write short and precise requirements such as "deegree shall support the brand new spec YX".
  • Provide as much information as possible as every detail is essential to a good feature request.
  • Earn Votes and Support by involving the community and invite everybody to discuss your feature and to vote for it (votes are +1 , 0 or -1) by sending a message to the users mailing list or use GitHub reactions directly. Read the DeegreeVotingProcess for more information about consensus decision.

Requesting a new feature

Enter an issue and fill in the following fields:

  • Title: Enter a clear and meaningful titel for your feature request
  • Description: Please give at least some information about:
    • Need: Briefly explain, use 2-3 sentences, why the new feature is important or necessary.
    • Value: Explain what will be the value of this feature for other deegree users.
    • Funding: Tell the community if you have money to fund this feature request or not. If you plan to implement the feature yourself this is a kind of funding as well. Read further in Sponsorship how to financially contribute.
  • Label: Please add the label "feature" to the ticket
  • Milestone: leave this field empty. The milestone will be set by the TMC members as soon as a pull request is provided.

Process and lifecycle of a feature request

  • After submitting your feature request the ticket will have state waiting for triage. In this state the TMC will read the request and decide if this fits into deegree webservices or not. Please expect questions by the TMC or other community members. In case the TMC has questions the label needs discussion will be added.
  • As soon as the TMC has accepted this feature it will change to state in progress and may have the label funding welcome.
  • After the funding is clarified and a developer is available the TMC will assign the ticket to someone. If funding is unclear the state will change to contributions welcome.
  • After the work is done the assigned developer reviews the issue and sets a fix version and set the label ready. When the work is finished and the pull request is accepted and merged by the TMC the issue and the pull request will be CLOSED.
Clone this wiki locally