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

Open-source Checklist #1

Open
11 of 12 tasks
tgolsson opened this issue May 15, 2022 · 1 comment
Open
11 of 12 tasks

Open-source Checklist #1

tgolsson opened this issue May 15, 2022 · 1 comment
Labels
enhancement New feature or request

Comments

@tgolsson
Copy link
Member

tgolsson commented May 15, 2022

  1. Create a new private or internal repository on GitHub using the open source template. If you already have a repository and want to maintain the commit history, you can instead add all the files from the template repository to your project.
  2. Edit the .github/CODEOWNERS file to contain the GitHub usernames of the project maintainers.
  3. If the project is a Rust project edit .github/workflows/rust-ci.yml to your needs, resolving all the comments marked TODO.
  4. If the project is not a Rust project remove the .github/workflows/rust-ci.yml file.
  5. If the project is a Rust library project to be pushed to Crates.io publish an version publish of the crate with cargo publish --token <TOKEN> where TOKEN is and API token for the embark-studios user. This shared bot account allows us to publish all crates under the same user and not have to worry about managing owners.
  6. Customise the README for your project by adding the appropriate name, description, links, and badges. This is also a great time to pick an emoji for the project!
  7. Add the EmbarkStudios / Open Source Admins group as admins in the repo access settings. Ask for assistance on slack if you do not have access to the repo settings.
  8. Post the private repo link with a description of what it is to the Embark #opensource Slack channel and ask for green-light to go ahead. Do @mention your manager also for visibility.
  9. Make the repository public.
  10. Add the project to the embark.dev list of open source projects.
  11. If the project is a Rust project add it to the embark.rs list of open source Rust projects.
  12. Announce the release on our Discord opensource channel and any other forums such as /r/rust. The ecosystem team can help you with this step. They will have the "community team" role on the Discord.
@tgolsson tgolsson added the enhancement New feature or request label May 15, 2022
@tgolsson
Copy link
Member Author

Lacking token for publish right now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant