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

Add repo and crate metadata #5

Merged
merged 6 commits into from
Sep 20, 2023
Merged

Add repo and crate metadata #5

merged 6 commits into from
Sep 20, 2023

Conversation

slowli
Copy link
Collaborator

@slowli slowli commented Sep 19, 2023

Adds various pieces of crate-level and repo-level metadata, such as:

  • PR / issue templates
  • Contributing guidelines
  • Security policy
  • html_root_urls for crates
  • Crate usage snippets in readmes

We aim to make it as easy as possible to contribute to the mission. This is still WIP, and we're happy for contributions
and suggestions here too. Some resources to help:

1. Developer docs can be found in [repo's readme](README.md)
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I plan to build and publish crate docs on GitHub Pages once the repo is public. Is this OK?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not?

CONTRIBUTING.md Outdated
Comment on lines 3 to 4
Hello! Thanks for your interest in joining the mission to accelerate the mass adoption of crypto for personal
sovereignty! We welcome contributions from anyone on the internet, and are grateful for even the smallest of fixes!
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this intro be copied verbatim? This repo is not limited to crypto 🙃

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's totally fine to modify it to your preference; this is a general-purpose crate indeed.

@slowli slowli marked this pull request as ready for review September 19, 2023 15:03
@slowli slowli requested review from popzxc and shahar4 September 19, 2023 15:03
Copy link
Member

@popzxc popzxc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fine with PR as-is, but feel free to modify as well.

@slowli slowli merged commit b9e373a into main Sep 20, 2023
@slowli slowli deleted the metadata branch September 20, 2023 06:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants