Skip to content

Latest commit

 

History

History
71 lines (44 loc) · 3.15 KB

CONTRIBUTING.md

File metadata and controls

71 lines (44 loc) · 3.15 KB
Raw

Welcome Contributors

Firstly thank you for taking out your precious time to contribute in this project. We here at MLSC welcome all the contributors.✨🎉

The following is a set of guidelines for contributing to this repository. These are mostly guidelines, which you need to keep in mind before contributing to this repository. Use your best judgement, and feel free to propose changes to this document in a pull request.🤝

Advice for new contributors

Start small. The PRs most likely to be merged are the ones that make small, easily reviewed changes with clear and specific intentions.

It's a good idea to gauge interest in your intended work by finding the current issue for it or creating a new one for yourself. Once you've spent a little bit of time planning your solution, it's a good idea to go back to the issue and talk about your approach.

Table of Contents

  1. How to Submit Changes
  2. Style Guide
  3. Where Can I Ask for Help?

How to Submit Changes

  1. The First Step

  • First things first, fork the MAKEATHON repository into your own GitHub account, and create a local clone of your own fork. Follow the steps mentioned below:
    git clone
  • Open this local repository on your local machinery and start implementing.
  • It is mandatory to fork the repository and you need to commit all your changes in the forked repository before making pull request.
  • It is also mandatory to create a branch in your forked repository before making pull request.
    For e.g
    git checkout -b SectionName_branch


  1. The Second Step

  • Go to the original remote repository and checkout the issues tab and comment on the issue want to work on.
  • The issues will be assigned on first request basis by a maintainer.

  1. The Third Step

  • Enter the directory in which you want to make the changes:
    cd directory_name
  • Now make all the necessary changes in your own directory.
  • Once all the changes have been made, generate a pull request(PR) and add at least one of the Maintainers as a Reviewer for the same.
  • When the Reviewer fully accepts the features or the issue is fully resolved your branch will be merged with the master branch.

  1. IMPORTANT GUIDELINES

  • Prettier for HTML, CSS, JS files.
  • Set Tab-width: 4
  • Indent inner HTML code.

  1. Other Important Points

  • Write meaningful commit messages, briefly detailing whatever changes you have done or added.
  • It is important that you link the concerned issue with the pull request (In the description of your PR write "This fixes #).

Style Guide

Format JS, CSS, HTML files using Prettier before creating a pull request.

Documentation styleguide involves Markdown.

Where Can I Ask for Help?

We have a Discord Community where you can stay updated with our latest developments and active members willing to help you out if you have any questions.