Create create-feature-request.md

[ci skip]
pull/5269/head
RobinWagner 8 years ago committed by GitHub
parent 30077caa9c
commit c355e589c3
  1. 72
      doc/development/create-feature-request.md

@ -0,0 +1,72 @@
# Create a feature request
## How to create a feature request?
1. Follow the link below to create a new work package.
2. Set Type to "Feature".
3. Add a detailed Description.
4. Attach a File (optional).
5. Set Version to "Wish List".
6. Press Create.
Note: Consider the [Feature Request Guidelines](https://github.com/opf/openproject/new/release/6.1/doc/development#feature-request-guidelines) below.
**Follow [this link](https://community.openproject.org/projects/openproject/work_packages/new) to create a feature request.**
## Feature Request Guidelines
### Feature title
* The title of the feature request should be as concise and crisp as possible.
* The respective module is specified in brackets in front of the title (optional).
**Example:**
> [Backlogs] Grey out status fields in task board which cannot be used by role
### Feature description
* The feature description should be concise and expressive.
* Mention the reason why the change is relevant. Describe the associated use case.
* Add acceptance criteria for clarification.
* Describe the current behavior if it is to be changed by the request.
### Short description of the feature
* Using the following (user story) format, describe the intent behind a new feature request:
> As ...
> I want ...
> so that ...
**Example:**
> AS an OpenProject user
> I WANT to only show the allowed status fields as active for which a status transition is allowed based on the workflow
> SO THAT I am clearly aware which status transitions are allowed before doing them.
### Acceptance criteria
* State and detail the requirements in the acceptance criteria.
**Example:**
> * In the task board only show the status allowed for the role the user has in the project as active.
> * The status fields which are inactive should have e.g. a grey background to make clear that a user cannot use them.
### Current behavior
* If the feature request is changing existing behavior, briefly explain the current behavior.
**Example:**
> Currently, all status transitions set for a type are displayed as active (independent of the allowed status transitions defined by the workflow).
### Wireframes / Screenshots
* If the request is visual, it is helpful to add a short wireframe or a screenshot in which changes are highlighted.
* The wireframe or screenshot can be attached as a file and can be integrated in the description with the following syntax: "!Name_of_screenshot.png!" (without quotation marks)
(Notice: Name_of_screenshot should be replaced with the respective name of the file. The file ending (here: .png) has to be adjusted to the appropriate file type of the screenshot.)
## Example of a feature request
![Feature Request](https://openproject.org/wp-content/uploads/2016/10/FeatureRequest.png "Feature Request")
Loading…
Cancel
Save