diff --git a/Contributors&Credits.md b/CONTRIBUTING.md similarity index 100% rename from Contributors&Credits.md rename to CONTRIBUTING.md diff --git a/README.md b/README.md index 866d7bc..489db82 100644 --- a/README.md +++ b/README.md @@ -52,11 +52,3 @@ #### [๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Contributors](./Contributors&Credits.md) A list of individuals who have contributed to this project. Add your name and link in [Contributors&Credits.md](./Contributors&Credits.md#contributors). - -#### [๐Ÿง‘โ€๐Ÿ’ป Credits & Authors](./Contributors&Credits.md#credits-authors) - -Acknowledgment of the original authors. Add your name or blog if you authored a command or section. - -#### [๐Ÿ“– References & Resources](./Contributors&Credits.md#references-resources) - -A collection of blogs, articles, and materials used to learn more about Git. Add your favorite resources! diff --git a/scripts/generate-readme.js b/scripts/generate-readme.js index eb5e17e..5571813 100644 --- a/scripts/generate-readme.js +++ b/scripts/generate-readme.js @@ -17,19 +17,11 @@ const CONCLUSION = ` ## Contributors & Credits > [!NOTE] -> Want to contribute? Add yourself as a contributor or author by following the [Contribution Format Guide](./dev-docs/FORMAT.md) and submitting a Pull Request. +> Want to contribute? Be a contributor or author by following the [Contribution Format Guide](./dev-docs/FORMAT.md) , also add your favorite resources in [References & Resources](./CONTRIBUTING.md#references-resources) and submit a Pull Request. -#### [๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Contributors](./Contributors&Credits.md) +#### [๐Ÿ‘จโ€๐Ÿ‘ฉโ€๐Ÿ‘งโ€๐Ÿ‘ฆ Contributors](./CONTRIBUTING.md) -A list of individuals who have contributed to this project. Add your name and link in [Contributors&Credits.md](./Contributors&Credits.md#contributors). - -#### [๐Ÿง‘โ€๐Ÿ’ป Credits & Authors](./Contributors&Credits.md#credits-authors) - -Acknowledgment of the original authors. Add your name or blog if you authored a command or section. - -#### [๐Ÿ“– References & Resources](./Contributors&Credits.md#references-resources) - -A collection of blogs, articles, and materials used to learn more about Git. Add your favorite resources! +A list of individuals who have contributed to this project. Add your name and link in [CONTRIBUTING.md](./CONTRIBUTING.md#contributors). Please follow the instructions from [FORMAT.md](./dev-docs/FORMAT.md) when contributing. `; const TOC_JSON = path.join(__dirname, '..', 'toc-source.json');