Skip to content

Commit

Permalink
docs: add the naming ADR
Browse files Browse the repository at this point in the history
  • Loading branch information
MaferMazu committed Nov 7, 2023
1 parent 71c4990 commit 53a9ef3
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions docs/source/decisions/0004-naming-of-the-plugin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
4. Naming of the plugin
========================

Status
******

Accepted


Context
*******

Initially, we wanted a very descriptive name for this plugin (Open edX WooCommerce Plugin) to avoid confusion because there are different types of plugins in Open edX. Still, for `WordPress plugin guidelines`_, we cannot submit a plugin with the word "plugin" or trademarks as "woocommerce."

Decision
********

- Change the name of the plugin to "Open edX Commerce."


Consequences
************

- Change the name in all the code, including files and database names.

- The WordPress plugin doesn't have the same name as the GitHub repository to store more information about this plugin that adds information in the Open edX context.


Rejected Alternatives
*********************

- Use "ecommerce" in the name: to avoid confusion with the current e-commerce service.


References
**********

- `WordPress plugin guidelines`_.
- `Current ecommerce service`_.


.. _WordPress plugin guidelines: https://developer.wordpress.org/plugins/wordpress-org/detailed-plugin-guidelines/#17-plugins-must-respect-trademarks-copyrights-and-project-names
.. _Current ecommerce service: https://github.com/openedx/ecommerce

0 comments on commit 53a9ef3

Please sign in to comment.