From 71ce57aa7d8cda92d9c2da7b8681a0450bc83c61 Mon Sep 17 00:00:00 2001 From: Brandon Xu <76601710+brandonxu360@users.noreply.github.com> Date: Mon, 11 Mar 2024 01:20:32 -0700 Subject: [PATCH 1/3] Docs: fix collaboration dead links Changed previously dead documentation and showcase links to working destinations --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4cb17377..7935c001 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,8 +12,8 @@ Any contribution is welcome as long as you uphold the [Code of Conduct](CODE_OF_ - 🐛 Create a [bug report](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=bug&template=bug_report.md&title=%5BBug%5D) - 🌺 Suggest an [enhancement](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=enhancement&template=feature_request.md&title=%5BFeature%5D) - ✨ Check out the [example applications](https://github.com/miroiu/nodify/tree/master/Examples) -- 🎉 Consider [showcasing your application](https://miroiu.github.io/nodify/showcase/) -- 📝 Help with the [documentation](https://miroiu.github.io/nodify/docs) +- 🎉 Consider [showcasing your application](https://miroiu.github.io/nodify/#showcase) +- 📝 Help with the [documentation](https://github.com/miroiu/nodify/wiki) - Fix a [bug](https://github.com/miroiu/nodify/labels/bug) - Create a pull request linking to a [feature](https://github.com/miroiu/nodify/labels/enhancement) @@ -21,6 +21,6 @@ Any contribution is welcome as long as you uphold the [Code of Conduct](CODE_OF_ - Write clear and descriptive issues and try to avoid duplication - If you find a **Closed** issue that relates to yours, open a new issue and include a link to the original issue in the body of your new one. -- The easiest way to update documentation is to navigate [to the docs website](https://miroiu.github.io/nodify/docs/) and click 'Edit this page' which is found at the bottom of any page. +- The easiest way to update documentation is to navigate [to the docs website](https://github.com/miroiu/nodify/wiki) and click 'Edit this page' which is found at the top right of any page. - If you want to create an example application that others can use to learn from, then [create an issue](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=application&template=add_example_app.md&title=%5BApplication%5D) describing what your application is doing and if you need help with anything. - The application you showcase can use any license. From d04d4c9751a14a666fbc4f02de478d1a67206f3b Mon Sep 17 00:00:00 2001 From: Brandon Xu <76601710+brandonxu360@users.noreply.github.com> Date: Mon, 11 Mar 2024 01:42:57 -0700 Subject: [PATCH 2/3] docs: update contributing doc --- CONTRIBUTING.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7935c001..3d693446 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,21 +1,21 @@ # 👋 **Welcome to Nodify!** 👋 -👍🎉 First off, thanks for taking the time to contribute! 👍🎉 +👍🎉 First off, thanks for taking the time to contribute! Your contributions help make Nodify better for everyone. 👍🎉 -The best contribution of all is to give this project a ⭐ **star** ⭐. +If you find Nodify useful, please consider giving us a ⭐ **star** ⭐ on our GitHub repository! -Any contribution is welcome as long as you uphold the [Code of Conduct](CODE_OF_CONDUCT.md). *(don't even waste time reading it, it's common sense 😎)* +Code of Conduct: By contributing to Nodify, you agree to uphold our [Code of Conduct](CODE_OF_CONDUCT.md). We expect all contributors to be respectful and inclusive. (Don't worry, it's all common sense 😎) ## How you can contribute -- ❓ Ask [a question](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=question&template=ask-a-question.md&title=%5BQuestion%5D) -- 🐛 Create a [bug report](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=bug&template=bug_report.md&title=%5BBug%5D) -- 🌺 Suggest an [enhancement](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=enhancement&template=feature_request.md&title=%5BFeature%5D) -- ✨ Check out the [example applications](https://github.com/miroiu/nodify/tree/master/Examples) -- 🎉 Consider [showcasing your application](https://miroiu.github.io/nodify/#showcase) -- 📝 Help with the [documentation](https://github.com/miroiu/nodify/wiki) -- Fix a [bug](https://github.com/miroiu/nodify/labels/bug) -- Create a pull request linking to a [feature](https://github.com/miroiu/nodify/labels/enhancement) +- ❓ [Ask a question](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=question&template=ask-a-question.md&title=%5BQuestion%5D) - If you're unsure about anything related to Nodify, feel free to ask! No question is too small. +- 🐛 [Create a bug report](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=bug&template=bug_report.md&title=%5BBug%5D) - Noticed something not working as expected? Let us know by creating a bug report. Please provide as much detail as possible to help us address the issue. +- 🌺 [Suggest an enhancement](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=enhancement&template=feature_request.md&title=%5BFeature%5D) - Have an idea to make Nodify even better? We'd love to hear it! Share your suggestions for new features or improvements. +- ✨ [Explore example applications](https://github.com/miroiu/nodify/tree/master/Examples) - Check out the example applications provided with Nodify. They're great for learning how to use the library in different scenarios. +- 🎉 [Showcase your application](https://miroiu.github.io/nodify/#showcase) - Built something cool with Nodify? Share it with the community! We'd love to see what you've created. +- 📝 [Help with the documentation](https://github.com/miroiu/nodify/wiki) - Documentation is crucial for making Nodify accessible to everyone. If you spot errors or have suggestions for improvement, please let us know or update the docs yourself! +- 🔧 [Fix a bug](https://github.com/miroiu/nodify/labels/bug) - If you're a developer, you can contribute by fixing bugs in Nodify. Simply locate an open issue tagged as a bug and submit a pull request with your fix. +- 🔗 [Create a pull request linking to a feature](https://github.com/miroiu/nodify/labels/enhancement) - Implemented a new feature or enhancement? Fantastic! Submit a pull request linking to the relevant feature or enhancement issue. ## Some tips From 0a6084ddc5e0f3b4d5e6b16d60fe3b3b1d196258 Mon Sep 17 00:00:00 2001 From: Brandon Xu <76601710+brandonxu360@users.noreply.github.com> Date: Mon, 11 Mar 2024 15:18:42 -0700 Subject: [PATCH 3/3] docs: update showcase link --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3d693446..cfc4931a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,7 +12,7 @@ Code of Conduct: By contributing to Nodify, you agree to uphold our [Code of Con - 🐛 [Create a bug report](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=bug&template=bug_report.md&title=%5BBug%5D) - Noticed something not working as expected? Let us know by creating a bug report. Please provide as much detail as possible to help us address the issue. - 🌺 [Suggest an enhancement](https://github.com/miroiu/nodify/issues/new?assignees=miroiu&labels=enhancement&template=feature_request.md&title=%5BFeature%5D) - Have an idea to make Nodify even better? We'd love to hear it! Share your suggestions for new features or improvements. - ✨ [Explore example applications](https://github.com/miroiu/nodify/tree/master/Examples) - Check out the example applications provided with Nodify. They're great for learning how to use the library in different scenarios. -- 🎉 [Showcase your application](https://miroiu.github.io/nodify/#showcase) - Built something cool with Nodify? Share it with the community! We'd love to see what you've created. +- 🎉 [Showcase your application](https://github.com/miroiu/nodify/issues/56) - Built something cool with Nodify? Share it with the community! We'd love to see what you've created. - 📝 [Help with the documentation](https://github.com/miroiu/nodify/wiki) - Documentation is crucial for making Nodify accessible to everyone. If you spot errors or have suggestions for improvement, please let us know or update the docs yourself! - 🔧 [Fix a bug](https://github.com/miroiu/nodify/labels/bug) - If you're a developer, you can contribute by fixing bugs in Nodify. Simply locate an open issue tagged as a bug and submit a pull request with your fix. - 🔗 [Create a pull request linking to a feature](https://github.com/miroiu/nodify/labels/enhancement) - Implemented a new feature or enhancement? Fantastic! Submit a pull request linking to the relevant feature or enhancement issue.