Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
  1. Rename GitHub repository
    1. GitHub allows redirection from the old URL to the new one. Note however: This will only work as long as there isn't another project later created with the same (old) project name.
    2. Also note that contributors will receive a warning message from git prompting them to update their git remote URLs from the old the the new one. This is something that all contributors have to address locally on their own machines.
  2. Determine public vs. private API surface in order to get a clear picture on what code elements can be renamed without triggering a breaking change and therefore a major release (if using semantic versioning)
    1. Update source code references
      1. Classes
      2. Interfaces
      3. Imports
      4. Do keep in mind that these have to be separated based on internal vs. published API elements
  3. Update links pointing to the GitHub repository within
    1. source code
    2. documentation that's managed separately from the source code (if applicable)
  4. ReadTheDocs page (if applicable)
  5. Mailing list (Hyperledger staffCalendar meetings (where applicable)
    1. Note: mailing lists cannot be renamed. Instead a brand new list will have to be created by HL staff and then previous subscribers will have to subscribe to that one again.
  6. Chat rooms (Discord)
  7. Calendar meetings (where applicable)
    1. The calendar is tied to the mailing list meaning that once the brand new mailing list has been created the maintainers will have to manually recreate all the regular calendar entries.
  8. Wiki pages (Hyperledger staff/project maintainers)
  9. Project page update on Hyperledger site (Hyperledger staff)
  10. Package managers/published artifacts (where applicable)
    1. npm
    2. Maven/Gradle
    3. Container images
  11. Slide decks (if applicable)
  12. Whitepapers (if applicable)
  13. GitHub Integrations (where applicable):
    1. ZenHub
    2. MergeFreeze
    3. Jira
    4. Gitter
    5. GitGuardian
    6. etc.
  14. Hyperledger toppage (including Cactus GitHub URL) https://www.hyperledger.org/use/cactus
  15. We're done



...

Staff

  1. Project page update on Hyperledger site (Hyperledger staff)
  2. Rename GitHub repository
    1. GitHub allows redirection from the old URL to the new one. Note however: This will only work as long as there isn't another project later created with the same (old) project name.
    2. Also note that contributors will receive a warning message from git prompting them to update their git remote URLs from the old the the new one. This is something that all contributors have to address locally on their own machines.
  3. Mailing list (Hyperledger staff)
    1. Note: mailing lists cannot be renamed. Instead a brand new list will have to be created by Hyperledger staff and then previous subscribers will have to subscribe to that one again.
    2. Permissions will have to be set up from scratch (e.g. maintainers to be mods of the list, etc.)
  4. Chat rooms (Discord)