Skip to content
This repository has been archived by the owner on May 9, 2019. It is now read-only.

Creating Your First Project

Jump to bottom
dubeaud edited this page Dec 10, 2014 · 1 revision

This walkthrough provides a glimpse of the features that BugNET has to offer, provided as a step-by-step guide. If this is your first time using BugNET, this document is for you!

This topic assumes that you have already installed BugNET and set up your website. If you haven't, follow the instructions in Installing BugNET.

Create New Project

When you're logged in as an administrator, you will see two additional menu items, Admin and Host.

To create your first project, select Admin -> Projects then Create New Project. You are then presented with the create new project wizard that guides you through the various steps necessary to create a new project.

The following additional configuration options are not included in the project wizard and can be accessed through the edit project function after the project has been created:

  • Custom Fields
  • Security Roles
  • Mailboxes
  • Notifications
  • Subversion
  • Defaults

Project Details

This step allows you to give your project a name, description and set basic project properties of the project.

  • Project Name - The name of your project
  • Project Description - A description of your project that is shown to users on the home page
  • Project Code - A unique identifier for the project that prefixes all issues. i.e. BGN-1234
  • Project Manager - The BugNET user who manages this project, for information use only and displays on the home page for each project.
  • Allow Issue Voting - Allow users to vote on their favourite issues
  • Security Type
    • Public - All users can see this project
    • Private - Only project members can see this project
  • Allow Issue Attachments - All users to attach files to issues.
  • Storage Type - Store attachments in the database or file system. This cannot be changed after project creation.

Categories

When you create issues, you can assign the issue a category or component. These are added in a tree like structure where you can have a parent category and multiple sub categories.

Status

When you create an issue, you assign the issue a status such as In Progress or Completed. You can also associate an image with each status to help you identify them in the issue list or project summary pages.

Is Closed State is used to identify issues that are complete and should show in the Change Log. You can have multiple status values representing closed issues. When setting a status to Is Closed State issues that have this status are displayed on the change log and road map views accordingly.

Priorities

Priorities represent the important of an issue, such as High, Medium Low.

Milestones

Milestones represent a grouping of issues by release, version or "milestone".

  • Due Date - Represents the date in which this release is due and is shown on the Roadmap
  • Release Date - The date in which this milestone was released.
  • Completed - When a release is complete, it will no longer appear in the Roadmap.
  • Notes - These will display on the roadmap and change log pages under the name of the milestone.

Issue Types

Issue types identify the type of issue such as a Bug, New Feature or Task.

Resolutions

Resolutions identify how the issue was resolved or fixed.

Project Members

Add users that are members of a project on this step and assign them a specific role. If you have set your project to private then only the people added as members will be able to see your project.

Custom Fields

There may be necessary information that does not fall into the preset values of BugNET, in this case you can add custom fields of a certain data type capture additional information about an issue.

  • Field Name - Name that displays on the issue screen.
  • Field Type - The data type that you wish to display
  • Data Type - The data type to be validated
  • Required - If required then data entry is mandatory when creating and editing issues

Security Roles

Several security roles are added by default and can be modified as necessary.

  • If you would like to auto assign users to a particular role when they register, edit the role and check "Auto Assign" then save the role.

Notifications

Notifications allow you add users to receive project wide notifications for when issues are added or changed.

Subversion

The subversion screen allows you configure the repository url and create repository tags or create a new repository for the project.

  • Subversion Url - The url of your project SVN or source code repository , this is used to add an additional menu item that will allow you to view your code from BugNET (uses an iFrame)

Creating a Tag

To create a tag in your SVN repository enter the name and the comment then select create tag. The output of the SVN commands will be shown in the readonly Subversion Commands Output box to verify that your tag has been created successfully.

Create a new Repository

To create a new subversion repository for this project, enter the name of your SVN repository and click Create Repository.

Mailboxes

The mailboxes screen allows you to add mailboxes that the POP3 mailbox reader will access to create issues that have been submitted via email.

  • Email Address - The email address in which users or customers would send issues to
  • Assign To - The user in which new issues are to be assigned
  • Issue Type - The issue type that you would like to assign to new issues.

Defaults

The defaults screen allows you to set which fields are visible on the add issue screen and their default values.

  • Visible - toggles the display of this field on the new issue screen.
Clone this wiki locally