Editing a project's details

As a project admin, you can edit your project's:

  • Name 
  • Key
  • URL
  • Project type
  • Project category
  • Avatar
  • Description
  • Project lead
  • Default assignee

To edit a project's details:

  1. From your project's sidebar, select Project settings > Details.
  2. Make your edits.
  3. Select Save details.

If you change the name of your project, the new name will automatically update in any filters on your Jira site.

Change your project's key

To change your project's key:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Key field, enter your desired key. Your project's key must be at least 2 characters long and contain only uppercase letters.
  3. Select Save details.

After you change a key, we recommend communicating the change to your users. You will need to update board filters, dashboard filter gadgets, and any other global queries with the new key.

Additional notes to keep in mind when changing a project key...
  • You won't be able to create a new project with the old project key. The old project key will only be available if you delete the project it was previously associated with.
  • If you use Confluence with Jira, the Jira issue macros in Confluence will continue to work. Please note, if you don't see the change straight away, allow some time for the cache to refresh.
  • Links containing the old project key will continue to work, as link aliases will not be updated with the new key. For example, if you have a link to an issue 'EXAMPLE-1' in the description of an issue, and you change the project key 'EXAMPLE' to 'DEMO', then the alias 'EXAMPLE-1' will not be updated to 'DEMO-1'. The link will still direct you to DEMO-1.
  • You will still be able to access issue attachments tied to the old project key. The directory that attachments are stored in (under the <JIRA Home>\data\attachments directory) will be retain the old project key. For example, if you change a project's key from TEST to DEMO, the attachments will be stored under <JIRA Home>\data\attachments\TEST.
  • If you export and then import renamed project, it will only retain the updated project key. All historical keys for that project will be removed.

  • REST API calls will still work with old project key — REST calls that specify an issue key will work with the old issue key after the project key has changed. For example, /rest/api/issue/EXAMPLE-100 will still work after the project key is changed from EXAMPLE to DEMO.
    • If you need to retrieve all issue keys and project keys (historical and current), you can do this via the following:
      • REST: Get all project keys for a project: /rest/api/2/project/<project key>?expand=projectKeys

Link to more project details with a project URL

You can link team members and viewers to an external site by adding a project URL. The project URL displays  in the Projects directory of your site.

Most teams supply an address to documentation about the project, roadmaps or other important content outside of their Jira site. If you use Confluence to collaborate, we recommend adding a link to your team's space.

To change your project's URL:

  1. From your project's sidebar, select Project settings > Details.
  2. In the URL field, enter your link.
  3. Select Save details.

Add a project description

 Administrators can view the description in the Summary section of your project's settings.

To add or edit your project's description:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Description field, enter a brief, detailed explanation of the project.
  3. Select Save details.

Change your project's type

If you have multiple Jira apps on your site, you can choose to change your project's type. For example, if you have both Jira Core and Jira Software, you can upgrade a business project to a software project and get finer control over your project's workflow, board settings and more.

Changing a project type means changing the way your users work in that project. It's much easier to create a new project than change a project's type after extended use.

Read more about project types and what makes them different.

To change a project's type:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Project type field, select the type of project you want to change to.
  3. Select Save details.

Add or edit your project's category

Your Jira admin may add project categories to help manage projects across your Jira site. If they've added categories, you can assign your project to one of them in your project's details.

To change our project's category:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Category field, select the appropriate category from the drop down.
  3. Select Save details.

Change your project's avatar

Avatars help give a face to your project's name. They appear in the project sidebar and in your site's list of all projects.

To change your project's avatar:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Avatar field, select your current avatar.
  3. Choose from a default icon or upload your own.
  4. Select Save details.

Change the project lead

A project's lead is usually the project administrator, who controls and manages a project's settings.

You may want to change the project lead as people move in and out of your team in longer-term project.

To change your project's lead:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Project lead field, set a new person to lead the project.
  3. Select Save details.

Add or change your project's default assignee

When issues are created in your project, you can set a default assignee. This is useful for open projects where everyone on the site can report tasks to your project.

The default assignee is typically a team member who prioritizes or validates that reported issues are meant for their team and distributes these tasks to their team members accordingly. By default, they receive notification when someone creates an issue in the project.

To change your project's default assignee:

  1. From your project's sidebar, select Project settings > Details.
  2. In the Default assignee field, nominate your project's default assignee.
  3. Select Save details.
Last modified on May 31, 2018

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.