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

Improve the documentation for new contributors #562

Open
antoyo opened this issue Sep 23, 2024 · 0 comments
Open

Improve the documentation for new contributors #562

antoyo opened this issue Sep 23, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@antoyo
Copy link
Contributor

antoyo commented Sep 23, 2024

Add a guide for new contributors. Topic ideas would include:

  • Document the way to run a specific test.
  • Document an existing function (explaining why it does things like casting values) to explain core concepts.
  • Point to relevant documentation in the Rustc dev guide?
  • Perhaps have a "Getting started" contribution guide to explain how a potential contributor can show their interest so that we can guide them (like join IRC/Zulip to ask us where to start)?
@antoyo antoyo added the documentation Improvements or additions to documentation label Sep 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant