Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: [FC-0074] add naming suggestions to use when creating new events #467

Merged
merged 1 commit into from
Feb 18, 2025

Conversation

mariajgrimaldi
Copy link
Member

Description

This PR adds naming suggestions for implementing new Open edX Events.

Testing instructions

You can see the docs rendered here:

Deadline

"None" if there's no rush, or provide a specific date or event (and reason) if there is one.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Any other PRs or issues that should be linked here? Any related PRs?
  • Any special concerns or limitations? For example: deprecations, security, or anything you think should be noted.

Checklists

Check off if complete or not applicable:

Merge Checklist:

  • All reviewers approved
  • Reviewer tested the code following the testing instructions
  • CI build is green
  • Version bumped
  • Changelog record added with short description of the change and current date
  • Documentation updated (not only docstrings)
  • Integration with other services reviewed
  • Fixup commits are squashed away
  • Unit tests added/updated
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

  • Create a tag
  • Create a release on GitHub
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)
  • Upgrade the package in the Open edX platform requirements (if applicable)

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

openedx-webhooks commented Feb 14, 2025

Thanks for the pull request, @mariajgrimaldi!

This repository is currently maintained by @openedx/hooks-extension-framework.

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.

@mariajgrimaldi mariajgrimaldi force-pushed the MJG/name-suggestions-ref branch from 569eb3f to 76bdd2c Compare February 14, 2025 09:03
@mariajgrimaldi mariajgrimaldi marked this pull request as ready for review February 14, 2025 09:05
@mariajgrimaldi mariajgrimaldi requested a review from a team as a code owner February 14, 2025 09:05
@mariajgrimaldi mariajgrimaldi changed the title docs: add naming suggestions to use when creating new events docs: [FC-0074] add naming suggestions to use when creating new events Feb 14, 2025
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Feb 14, 2025

When naming a new event and contributing it back to this repository, consider the following suggestions:

- Use a name that is descriptive to the event's purpose. For example, the event associated with a user's enrollment in a course is named ``COURSE_ENROLLMENT_CREATED``, which clearly indicates the event's purpose.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do you think the name should always have a verb in it? Generally would it always be a verb in past tense eg created, enrolled, succeeded, failed?

Copy link
Member Author

@mariajgrimaldi mariajgrimaldi Feb 18, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this commit I specified where this standard we've enforced so far comes from: 34562b1. So yes, according to the naming and versioning ADR, those are the usual verbs that are used for the event type string when following OEP-41.

@mariajgrimaldi mariajgrimaldi merged commit 644ebd8 into main Feb 18, 2025
11 checks passed
@mariajgrimaldi mariajgrimaldi deleted the MJG/name-suggestions-ref branch February 18, 2025 15:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants