Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 2.37 KB

CONTRIBUTING.md

File metadata and controls

40 lines (26 loc) · 2.37 KB

Contributing to hacksoc.in website

We ❤️ contributions from our community! Thank you for taking the time to review this guide and understand how we work. And please remember, all interactions in this repository should adhere to the code of conduct.

💡 🐛
Have an idea for improvement? Open an issue first and let's talk about it. Need help understanding the code? Check out the README or get in touch with us on Slack (invite link on website). Did you find a bug? Open an issue.

How you can help

You can help by contributing code or reviewing open pull requests.

Must read guidelines

Basics

If you are new to version control or Open Source, you may as well start here! 😄

If you are interested in contributing to this project, do the following:

  1. GitHub forks the repo on GitHub
  2. Clone the project to your own machine
  3. Open an issue in this repository (an issue says what feature/bug needs to be worked upon. If you plan to work on it, assign it to yourselves.)
  4. Commit changes to your own branch
  5. Push your work back up to your fork
  6. Submit a Pull request so that we can review and merge your changes

PR/Commit Guidelines

There are certain conventions we follow in the project, we recommend that you become familiar with these so that the development process is uniform for everyone.

Please help us follow best practices to make it easy for the reviewer as well as the contributor.

  • Single commit per pull request. (Please squash all your commits as multiple commits make it harder for reviewers to review, and thereby increase the time it will take to merge your PR.)
  • For writing commit messages please read FOSSASIA's COMMITSTYLE carefully. Kindly adhere to the guidelines.
  • If the PR is related to any front end change, please either attach relevant screenshots or describe point by point each of your changes in the pull request description.

References:

README: FOSSASIA