Versions Compared

Key

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

...

While we encourage you to try and follow these guidelines, do not let these keep you from contributing!


Table of contents

Table of Contents

Non technical / Quickstart

Just add your input as a story on JIRA (smile)(smile)
If possible read this document and try to follow it.

...

  • Bug
    • A problem which impairs or prevents the functions of the product.
  • Task
    • A (small) task that needs to be done.
  • Improvement
    • An improvement or enhancement to an existing feature or task.
  • New Feature
    • A suggested new feature of the product, which has yet to be accepted to be included in the final product.
  • Story
    • An issue of which the issue type is not further specified.
    • New users: Use stories and just give your input, we will further categorize it for you.
  • Epic
    • A more complicated feature or action which needs to be broken down.
  • Image AddedDiscussion
    • A subject related to the project that needs discussion or feedback.

When filing a new issue, think about what kind of issue it is and if unsure label it as a story.

...

When creating a new issue please take the following conventions in account. These conventions are split between bugs and non-bugs:

  • Suggestions (non-bugs)Image Removed
    • Formulate the summary in a short, clear and imperative way
      • Add a couch surfing mechanism
      • Give newly registered users an O365 account
    • Formulate the description in an explaining, extensive, and natural way
      • As an AEGEE-member, I would like to use the OMS to easily find a place to couch surf.
      • As a newly registered user, I would like to receive an office-365 account for personal use.
    • Add examples and other information at the end of the description

    • Make it clear, avoid confusion
  • Improvement:Image Added
    • Formulate the current behaviour
      • When I press the event page I am to able to filter on the dates of the event.
    • Formulate the intended behaviour
      • When I press the event page I am also able to filter on end date of the application period.
    • Add examples and other information at the end of the description
    • Make it clear, avoid confusion
  • Bug reports: 
    • Formulate the summary in a short and clear way. Leave out the subject of the sentence.
      • Cannot save a news story
      • Error when loading a page while impersonating
    • Formulate the description in a detailed explanation of how to reproduce the bug.
      • Steps to reproduce:

        • Find a user to impersonate
        • Press impersonate
        • The page reloads and the following notification shows twice:
          Permission error!
          Not enough permissions!
    • Use screenshots or other attachments to make things more clear!
    • Add examples and other information at the end of the description
    • Make it clear, avoid confusion
  • Discussion: Image Added
    • Formulate the summary in a clear and concrete question
    • Add extra information and context to the description
    • Keep the summary and description objective, voice your opinion in the comments.

Issue priorities

For the priorities we will use the standard definitions given by JIRA:

...

JIRA has a pretty awesome planning tool called portfolio. In here we define multiple cross-project releases and specify which issues should be in which release. Important for you to know is that you can see the issues that should be done first by having a look at the releases of the project you are working on. While Derk Snijders is mainly responsible for setting the releases, you can always approach him with feedback/suggestions on it!

JIRA integrations

  • We integrated JIRA with Slack in order to be able to keep track on changes in issues from the safety and comfort of Slack.
  • JIRA is also integrated with Git, when you use a JIRA issue code (ie. 'CORE-33') in your branch/commit/pull-request, it automatically links to it on the issue page!