Skip to content

Latest commit

 

History

History
75 lines (68 loc) · 3.91 KB

CONTRIBUTION.md

File metadata and controls

75 lines (68 loc) · 3.91 KB

Contribution Guidelines

Before Contributing

Welcome to WiOSc/wios-website! Before submitting a pull request, please ensure that you read the guidelines thoroughly. You can work on any of these Issues, and if you are to find any other issues apart from those already mentioned, then inform one of the maintainers or reach out to the technical lead/co-lead/admins on Whatsapp.
This website is under the MIT License

Contributing

How to Contribute?

1.Fork the Repository

  • If you’re planning to contribute, first fork this repository by clicking the "Fork" button at the top-right of the GitHub page.
  • Clone your forked repository to your local machine:
git clone https://github.com/WiOSc/wios-website.git
cd wios-website

2.Set up development environment

  • Make sure you have Node.js and npm installed.
  • Install dependencies by:
npm install

3.Find Issues to Work On

  • You can find open issues here.
  • Feel free to explore the list of issues or suggest new ones if you notice something missing or problematic.

4.Making Changes & Commit Messages

  • Coding Standards: Follow the coding standards mentioned in the Coding Standards section.
  • When contributing, ensure your code follows these guidelines and adheres to best practices.
  • Commit Message Format:
Resolved {Issue Title}_{Issue Number} (e.g., Resolved Header-1)
  • Example:
Resolved Mobile-Menu-3: Fixed alignment issue on smaller screens.

5.Pull Requests

  • Once you’ve made your changes, create a new branch for your feature or fix:
git checkout -b feature-name
  • Push your branch and create a pull request (PR) from your forked repository to the main repository:
git push origin feature-name
  • Go to the GitHub repository and create a new pull request.
  • Provide a clear and concise description of your changes, including the issue number you're resolving.

6.Review & Feedback

  • Your pull request will be reviewed by maintainers fortnightly.
  • Address any feedback or requests for changes.
  • Once approved, your contribution will be merged into the main repository.

Contributor

  • As a contributor, you have the liberty to practice new implementations e.g., trying out something new you learnt that could enhance the user experience or design of the WiOS website.
  • If you find an issue interesting and want to work on it, kindly let the maintainers/technical lead/co-lead/admins know so that they can assign you that particular issue. This way multiple developers won't be working on the same issue.

    P.S. you can also mention this as your open source contribution in your resume or while giving interview.

Coding Standards

  • Use consistent indentation with 2 spaces (no tabs).
  • Ensure all HTML, CSS, and JS files follow a clean, readable structure.
  • Avoid unnecessary comments; ensure clarity in code.
  • Code should be modular, reusable, and organized logically.

Naming Conventions

  • HTML Elements: Use lowercase and hyphens (kebab-case) for IDs, classes, and attributes (e.g., class="header-title").
  • CSS Classes and IDs: Use lowercase and kebab-case (e.g., .nav-bar, #main-content).
  • JavaScript: Use camelCase for functions and variables (e.g., functionName, variableName)

Contributions

All sorts of contribution to the website are welcomed. From fixing grammatical errors to beautifying code blocks to re-designing a page, no contribution is small in our eyes.

  • Most importantly,
    • Be consistent in the use of these guidelines when submitting.
    • Join our Open Source talks' page on Whatsapp, where we conduct speaker sessions from experienced coders in the field.
    • Happy coding!

Writer @ChiragAJain, Dec 2024.