diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0107d0e505..bbd0ab3abf 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,13 +1,11 @@ -Welcome to the `esp-hal` Contributing Guide -=========================================== +# Welcome to the `esp-hal` Contributing Guide Thank you for considering contributing to our project! Your efforts help make `esp-hal` a better ecosystem for everyone. This guide outlines the contribution workflow, from reporting issues and submitting pull requests, to the review process and eventual merger of contributions. -Quick Navigation ----------------- +# Quick Navigation * [New Contributor Guide] * [Getting Started] @@ -27,8 +25,7 @@ Quick Navigation [Pull Request: From Submission to Merge]: #pull-request-from-submission-to-merge [Your PR is merged!]: #your-pr-is-merged -New Contributor Guide ---------------------- +# New Contributor Guide Welcome aboard! If you're new to `esp-hal` or open-source contribution, here are some resources to get you started: @@ -44,8 +41,7 @@ Welcome aboard! If you're new to `esp-hal` or open-source contribution, here are [GitHub Flow]: https://docs.github.com/en/get-started/quickstart/github-flow [Pull Requests]: https://docs.github.com/en/github/collaborating-with-pull-requests -Getting Started ---------------- +# Getting Started ### Issues: Reporting and Resolving @@ -99,7 +95,7 @@ cp pre-commit .git/hooks/pre-commit ``` -### Pull Request: From Submission to Merge +## Pull Request: From Submission to Merge * Fill the pull request template so that we can review your PR. This template helps reviewers understand your changes as well as the purpose of your pull request. * [Link your PR] to any relevant issues it addresses. @@ -117,8 +113,7 @@ cp pre-commit .git/hooks/pre-commit [this git tutorial]: https://github.com/skills/resolve-merge-conflicts -### Your PR is Merged! ------------- +## Your PR is Merged! Congratulations! The `esp-rs` team thanks you for your contributions!