Skip to content

Commit

Permalink
Merge pull request #63 from RishavOsaurus/main
Browse files Browse the repository at this point in the history
docs: Created CONTRIBUTING.md for hacktoberfest
  • Loading branch information
SatyaRajAwasth1 authored Sep 29, 2024
2 parents 4359460 + 08619d9 commit 4d77710
Showing 1 changed file with 82 additions and 0 deletions.
82 changes: 82 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# 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. 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

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:[email protected])

0 comments on commit 4d77710

Please sign in to comment.