Skip to content

CHECKLIST.md

Latest commit

 

History

History
34 lines (26 loc) · 3.17 KB

CHECKLIST.md

File metadata and controls

34 lines (26 loc) · 3.17 KB

Release Checklist

Follow these step-by-step tasks to release and maintain your open source project using the MIT license. Ensure you complete each item before moving on to the next. This file is only for repo owner, not for production. DELETE THIS FILE WHEN YOU ARE DONE WITH THE RELEASE.

  1. Register your release:

    • Use the Open Source Portal to register your intended release and get a release pre-approval.
    • This will trigger a review by CELA and management.
    • Follow the “AzProjectName” naming scheme for the project.

  2. Create and initialize a GitHub repository:

    • Create your GitHub repository using the repository wizard.
    • Repository needs a direct owner and a co-owner, and it should be mapped to a Service in the Service Tree. (ex: Xstore)
    • Repositories must be hosted within a 1ES-managed GitHub organization and may not be made public until the release registration is approved by CELA and management. If you got your release pre-approval you can make your repo public.
    • This template includes all the required files in the root directory.

  3. Prepare the code for release:

    • Edit the README.md following the format in the template.
    • Edit the CODEOWNERS file under .github/ folder with the owner's GitHub username.
    • Remove sensitive assets, such as internal or confidential information, internal paths, tools, codenames, proprietary fonts, internal telemetry, and email aliases.
    • Remove any trademarks or product icons.
    • If your repository includes third-party OSS, describe its use and its license in a NOTICE file. Consult with OSS CELA when in doubt.
  • Once you follow all the steps in CHECKLIST.md remove the file from the repository.

  1. Publish the code:

    • Once your registration and review process is complete, make your GitHub repository public. The repository should include a short and comprehensive Description. The link to the created sample or documentation should be provided in the Website section. To increase discoverability and categorization, add related topics.

  2. Register the sample in Samples Gallery

If you need more information check out the detailed instructions and https://aka.ms/opensource