Skip to content
This repository has been archived by the owner on Nov 4, 2024. It is now read-only.

docs: updated readme for 2u/release contributions #3927

Merged
merged 1 commit into from
Dec 5, 2023

Conversation

wdrussell2015
Copy link
Contributor

⛔️ DEPRECATION WARNING

This repository is deprecated and in maintainence-only operation while we work on a replacement, please see this announcement for more information.

Although we have stopped integrating new contributions, we always appreciate security disclosures and patches sent to [email protected]

Anyone internally merging to this repository is expected to release and monitor their changes; if you are not able to do this DO NOT MERGE, please coordinate with someone who can to ensure that the changes are released.

Required Testing

  • Before deploying this change, complete a purchase in the stage environment.
    (^ We can remove that manual check once REV-2624 is done and the corresponding e2e test runs again)

Description

Describe what this pull request changes, and why these changes were made. How will these changes affect other people, installations of edx, etc.?
Please include links to any relevant ADRs, design artifacts, and decision documents. Make sure to document the rationale behind significant changes in the repo, per OEP-19, and can be
linked here.

Useful information to include:

  • Which edX user roles will this change impact? Common user roles are "Learner", "Course Author", "Developer", and "Operator".
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).
  • Provide links to the description of corresponding configuration changes. Remember to correctly annotate these changes.

Supporting information

Link to other information about the change, such as Jira issues, GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

Please provide detailed step-by-step instructions for testing this change; how did YOU test this change?

Other information

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

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, OpenEdx vs. edx.org differences, development vs. production environment differences, security, or accessibility.

@wdrussell2015 wdrussell2015 requested a review from nedbat March 15, 2023 13:30
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
@christopappas christopappas requested a review from a team as a code owner December 4, 2023 15:09
Copy link
Contributor

@nedbat nedbat left a comment

Choose a reason for hiding this comment

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

A few grammar tweaks. Good to go!

docs/decisions/0008-master-branch-split.rst Outdated Show resolved Hide resolved
docs/decisions/0008-master-branch-split.rst Outdated Show resolved Hide resolved
docs/decisions/0008-master-branch-split.rst Outdated Show resolved Hide resolved
docs/decisions/0008-master-branch-split.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
README.rst Outdated Show resolved Hide resolved
breaking functionality for 2U or 2U committing changes to "master" that are irrelevant or
otherwise inappropriate for the community's use case.

Because protected branches in ecommerce require a user with Write access to the repository,
Copy link
Contributor

Choose a reason for hiding this comment

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

Could we add this information to the README? I am not sure it's clear master will now only rely on community review only. We could separate the "How to Contribute" section into Open Source and 2U contributions

Copy link
Contributor

Choose a reason for hiding this comment

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

For what it's worth, how the community wants to interact with ecommerce is actually still an open question (most likely for Axim) that has been raised already. I'm not sure I could really add specifics around community review and master other than "2U wont be doing it" 🤔

@christopappas christopappas force-pushed the wrussell/REV-3282-readme branch 3 times, most recently from a12d8e6 to 780e0c5 Compare December 4, 2023 20:50
fix: changed branch name from 2u/release to 2u/main

fix: updated readme syntax

docs: update PR template

docs: add decision record for master branch split

Update docs/decisions/0008-master-branch-split.rst

Co-authored-by: Ned Batchelder <[email protected]>

Update docs/decisions/0008-master-branch-split.rst

Co-authored-by: Ned Batchelder <[email protected]>

docs: feedback

Update docs/decisions/0008-master-branch-split.rst

Co-authored-by: Ned Batchelder <[email protected]>

docs: update a link

chore: adding back link change i clobbered by accident

docs: use correctly cased branch in heading
@christopappas christopappas force-pushed the wrussell/REV-3282-readme branch from 780e0c5 to 83bf32c Compare December 4, 2023 20:52
@christopappas christopappas merged commit 700cc13 into master Dec 5, 2023
8 checks passed
@christopappas christopappas deleted the wrussell/REV-3282-readme branch December 5, 2023 15:50
christopappas pushed a commit to christopappas/ecommerce that referenced this pull request Dec 5, 2023
christopappas added a commit that referenced this pull request Dec 5, 2023
* docs: updated readme for 2u/release contributions (#3927)

* fix: update ci GHA to use 2u/main instead of 2u/release

---------

Co-authored-by: wdrussell2015 <[email protected]>
zubair-ce07 added a commit that referenced this pull request Jan 16, 2024
feat: resloved reserved keywords conflict

feat: add data mmigration to make basket_lineattribute value json compatible

docs: updated readme for 2u/release contributions (#3927)

docs: add decision record for master branch split

feat: add atlas pull support (#4051)

Refs: FC-0012 OEP-58

feat: added refund functionality
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants