Skip to content

Conversation

@efortish
Copy link

Restore "Adding Custom Fields to Registration" How-To Guide

Context

This PR restores the documentation guide for adding custom fields to the registration page in the Authn MFE. This guide was previously removed from the repository, but there is no clear trace of when or why it was deleted from the codebase.

The original file is: https://github.com/openedx/frontend-app-authn/blob/63d16364fc2aa6538dd876bd3f6fd5612a20d605/docs/how_tos/adding_custom_fields_to_the_registration.rst#b-add-fields-that-do-not-exist-in-the-user-profile-model

Problem

The documentation for extending registration fields is currently missing from the repository, making it difficult for operators to:

  • Understand how to add custom fields to the registration page
  • Configure REGISTRATION_EXTRA_FIELDS properly
  • Extend the UserProfile model with custom fields
  • Integrate custom forms with the Authn MFE

This documentation is essential for organizations that need to collect additional user information during registration beyond the standard fields (email, username, password, name).


Documentation Location

The restored documentation is located at:

docs/how_tos/adding_custom_fields_to_the_registration.rst

Key Topics Covered

  1. Introduction to custom registration fields
  2. Difference between required and optional fields
  3. Step-by-step configuration for existing fields
  4. Advanced guide for custom UserProfile field extensions
  5. Backend and frontend integration requirements
  6. Configuration examples for different deployment methods

Testing

  • I followed up the instructions and everything is working as expected

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 29, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @efortish!

This repository is currently maintained by @openedx/2u-infinity.

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.


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.

@codecov
Copy link

codecov bot commented Oct 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 87.57%. Comparing base (bee0afd) to head (2b28d9f).
⚠️ Report is 11 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #1595   +/-   ##
=======================================
  Coverage   87.57%   87.57%           
=======================================
  Files         125      125           
  Lines        2309     2309           
  Branches      644      644           
=======================================
  Hits         2022     2022           
  Misses        278      278           
  Partials        9        9           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Oct 29, 2025
@mphilbrick211 mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Nov 4, 2025
@mphilbrick211 mphilbrick211 requested a review from a team November 4, 2025 19:33
@mphilbrick211
Copy link

Hi @openedx/2u-infinity! Could someone please review / merge this for us?

@julrusak
Copy link

julrusak commented Nov 4, 2025

hi @mphilbrick211 ! The Infinity team is no longer at 2U, the new contractor team has been onboarded but I think similarly to the new team that replaced Phoenix, this new Auth team will not be maintainers of this application.
I'm happy to update any spreadsheets or docs required, feel free to connect with me!

@mphilbrick211 mphilbrick211 removed the request for review from a team December 12, 2025 20:34
@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Dec 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

needs test run Author's first PR to this repository, awaiting test authorization from Axim open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

4 participants