From 9bd51005bccb056b703bca26767f9ea3818e34f2 Mon Sep 17 00:00:00 2001 From: Rishav Chapagain Date: Sun, 29 Sep 2024 21:03:23 +0545 Subject: [PATCH 1/3] docs: create docs for Hacktoberfest --- CONTRIBUTING.md | 83 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 83 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..34e11ef --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,83 @@ +# Contribution Guide for NOSK Official Website 🌐 + +Welcome to the NOSK Official Website repository! We appreciate your interest in contributing to the development of the official website. Follow these steps to make your contributions. + +## How to Contribute + +1. **Register for Hacktoberfest**: Sign up for [Hacktoberfest 2024](https://hacktoberfest.com/) using your GitHub account to ensure your contributions are counted. + +2. **Check for the "hacktoberfest" Label**: + Ensure the issue you are working on has the **"hacktoberfest"** label. This will ensure your contribution counts towards Hacktoberfest. Only issues with this label will be counted for Hacktoberfest progress. + +3. **Fork the Repository**: + - Visit the [NOSK Official Website repository](https://github.com/noskofficial/noskofficial.github.io). + - Fork the repo by clicking the **Fork** button at the top-right corner. + +4. **Clone Your Fork**: + - Clone the repository to your local machine. + ```bash + git clone https://github.com/your-username/noskofficial.github.io.git + ``` + +5. **Make Changes**: + - You can add new features, update content, or improve the website design. + - For UI changes, consider checking the overall responsiveness and accessibility of your changes. + +6. **Test Your Changes**: + - Preview your changes locally. You can use tools like `Live Server` in VSCode or any similar environment. + - Ensure that the website works as expected on different screen sizes. + +7. **Commit Your Changes**: + - Once satisfied with your changes, commit them with a meaningful message. + ```bash + git add . + git commit -m "Update header layout for mobile responsiveness" + ``` + +8. **Push Your Changes to GitHub**: + - Push your changes to your forked repository on GitHub. + ```bash + git push + ``` + +9. **Submit a Pull Request**: + - Go to the [NOSK Official Website repository](https://github.com/noskofficial/noskofficial.github.io) and submit a PR. + - **Take a screenshot of your change** before submitting the PR and include it in the description. + - Apply the label **"submit-4-review"** to signal the maintainers to review your PR. + +10. **Review and Feedback**: + - The maintainers will review your PR. Please be open to feedback and be prepared to make additional changes if requested. + +## Rewards 🎁 + +- **Top 10 contributors** will win **exclusive NOSK t-shirts**! πŸ‘• +- **Top 50 contributors** will get **stickers**! πŸŽ‰ + +## Contribution Guidelines + +- **HTML/CSS Standards**: Follow best practices for HTML and CSS. Keep the design responsive and clean. +- **JavaScript**: Ensure any JavaScript code is well-documented and functional across modern browsers. +- **Commit Messages**: Be clear and concise. Explain the "what" and "why" of your changes. +- **Design Consistency**: Ensure your changes align with the overall design and branding of the website. + +## Stay Connected πŸ’¬ + +Join our community on: +- [Discord](https://discord.gg/ryUf3jjFJ6) +- [Telegram](https://t.me/noskgroup) + +## Resources + +- [GitHub Documentation](https://docs.github.com/en) +- [How to Create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) +- [Web Accessibility Guidelines](https://www.w3.org/WAI/WCAG21/quickref/) + +--- + +Thank you for your contributions! πŸ™Œ + +If you have any questions, feel free to reach out to the maintainers or open an issue. + +### Maintainers: +- [NOSK](mailto:nosk@ncit.edu.np) + From 5cbd07d4b3a078e483f70087bd41f6492466f488 Mon Sep 17 00:00:00 2001 From: Rishav Chapagain <113815102+RishavOsaurus@users.noreply.github.com> Date: Sun, 29 Sep 2024 21:08:09 +0545 Subject: [PATCH 2/3] docs: Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 34e11ef..85094a4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# Contribution Guide for NOSK Official Website 🌐 +# Contribution Guide for NOSK Official Website (Hacktoberfest) 🌐 Welcome to the NOSK Official Website repository! We appreciate your interest in contributing to the development of the official website. Follow these steps to make your contributions. From 08619d9d971cbdcdae5bc4b872bebbde66a1b808 Mon Sep 17 00:00:00 2001 From: Rishav Chapagain <113815102+RishavOsaurus@users.noreply.github.com> Date: Sun, 29 Sep 2024 21:37:03 +0545 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 85094a4..a825f89 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ -# Contribution Guide for NOSK Official Website (Hacktoberfest) 🌐 +# Contribution Guide for NOSK Official Website🌐 -Welcome to the NOSK Official Website repository! We appreciate your interest in contributing to the development of the official website. Follow these steps to make your contributions. +Welcome to the NOSK Official Website repository! We appreciate your interest in contributing to the development of the official website. We have added this project as part of **Hacktoberfest 2024**, and we welcome new contributors and public contributions too. Follow these steps to make your contributions. ## How to Contribute @@ -80,4 +80,3 @@ If you have any questions, feel free to reach out to the maintainers or open an ### Maintainers: - [NOSK](mailto:nosk@ncit.edu.np) -