Skip to content

Comments

docs: tag mutability adr#491

Open
jesperhodge wants to merge 2 commits intoopenedx:mainfrom
jesperhodge:jhodge/tag-mutability-adr
Open

docs: tag mutability adr#491
jesperhodge wants to merge 2 commits intoopenedx:mainfrom
jesperhodge:jhodge/tag-mutability-adr

Conversation

@jesperhodge
Copy link

@jesperhodge jesperhodge commented Feb 23, 2026

Description

This is an ADR addressing an ambiguity on what identifiers of a Tag in a Taxonomy should be editable.

For further details, see the Files changed, as well as the conversations in this PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 23, 2026
@openedx-webhooks
Copy link

openedx-webhooks commented Feb 23, 2026

Thanks for the pull request, @jesperhodge!

This repository is currently maintained by @axim-engineering.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.
🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads
🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details
Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@bradenmacdonald
Copy link
Contributor

I think this is a good summary of our conversation.

As for how to handle external_id, I think a compromise might be:

  • The taxonomy editor UI displays external IDs, but doesn't allow changing them. It may allow specifying them when creating a tag, and/or generate one based on the value if none is specified.
  • In the rare case where an external ID needs to be changed, that can be easily done by an administrator using the Django admin UI.

@jesperhodge
Copy link
Author

I think this is a good summary of our conversation.

As for how to handle external_id, I think a compromise might be:

  • The taxonomy editor UI displays external IDs, but doesn't allow changing them. It may allow specifying them when creating a tag, and/or generate one based on the value if none is specified.
  • In the rare case where an external ID needs to be changed, that can be easily done by an administrator using the Django admin UI.

Sounds good to me. Do you agree with this solution @mgwozdz-unicon ? In that case I'll put that in the ADR decision block and mark this as ready for review

@mgwozdz-unicon
Copy link

I think this is a good summary of our conversation.
As for how to handle external_id, I think a compromise might be:

  • The taxonomy editor UI displays external IDs, but doesn't allow changing them. It may allow specifying them when creating a tag, and/or generate one based on the value if none is specified.
  • In the rare case where an external ID needs to be changed, that can be easily done by an administrator using the Django admin UI.

Sounds good to me. Do you agree with this solution @mgwozdz-unicon ? In that case I'll put that in the ADR decision block and mark this as ready for review

Yes, I think this sounds good.

@jesperhodge jesperhodge marked this pull request as ready for review February 24, 2026 15:36
@jesperhodge
Copy link
Author

@bradenmacdonald ready for review

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

open-source-contribution PR author is not from Axim or 2U

Projects

Status: Needs Triage

Development

Successfully merging this pull request may close these issues.

5 participants