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

Create a checklist of things to verify when new crates are introduced. #2526

Closed
thomcc opened this issue Feb 22, 2022 · 3 comments · Fixed by #8266
Closed

Create a checklist of things to verify when new crates are introduced. #2526

thomcc opened this issue Feb 22, 2022 · 3 comments · Fixed by #8266
Assignees
Labels
good first issue hacktoberfest Apply to issues you want contributors to help with help wanted

Comments

@thomcc
Copy link
Contributor

thomcc commented Feb 22, 2022

Two things that were missed in the ockam_transport_ble review that we should be sure not to miss for new crates (for example ockam_transport_smoltcp in #2213):

  1. No CHANGELOG.md file. Initially, it should be empty. It's possible this should instead be handled by the changelog generation script.
  2. Use of a path = ... and no version = ... for the dependency on ockam (chore(rust): fixup ockam_transport_ble for publish (missing crate version) #2525). This failure manifests quite late in the process, and not during a part that handles interruption well so it's pretty important we catch this one in the future.

More broadly, there are certainly other things to check as well. We should make a list of these somewhere. It probably is too rare that we add new crates to be worth automating, but perhaps that's worthwhile too.


We love helping new contributors! ❤️
If you have questions or need help as you explore, please join us on Discord. If you're looking for other issues to contribute to, please checkout our good first issues.

@metaclips metaclips added good first issue help wanted hacktoberfest Apply to issues you want contributors to help with labels Sep 27, 2023
@PsychoPunkSage
Copy link
Contributor

Hi @thomcc
Can I work on this issue. it seems no one is working on it. Can I have a look at this issue?

@metaclips
Copy link
Member

@PsychoPunkSage it’s all yours

@PsychoPunkSage
Copy link
Contributor

Hi @metaclips
I made a PR. Please have a look at it.
Thank You

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue hacktoberfest Apply to issues you want contributors to help with help wanted
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants