Skip to content

Latest commit

 

History

History
83 lines (58 loc) · 3.43 KB

CONTRIBUTING.md

File metadata and controls

83 lines (58 loc) · 3.43 KB

Contribution Guide for NCIT Alumni Website (Hacktoberfest) 🌐

Welcome to the NCIT Alumni Website repository! We appreciate your interest in contributing to the development of the Alumni website. Follow these steps to make your contributions.

How to Contribute

  1. Register for Hacktoberfest: Sign up for Hacktoberfest 2024 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:

  4. Clone Your Fork:

    • Clone the repository to your local machine. 
      git clone https://github.com/your-username/ncitalumns.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. 
      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. 
      git push

  9. Submit a Pull Request:

    • Go to the NCIT Alumni Website repository 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. Make sure to follow the Conventional Commits.
  • Design Consistency: Ensure your changes align with the overall design and branding of the website.

Stay Connected 💬

Join our community on:

Resources

Thank you for your contributions! 🙌

If you have any questions, feel free to reach out to the maintainers or open an issue.

Maintainers: