Skip to content

Latest commit

 

History

History
114 lines (73 loc) · 4.77 KB

Contributing.md

File metadata and controls

114 lines (73 loc) · 4.77 KB

Guidelines for Contributing to Schooler - SLoP

This project is being mentored by Meet Patel and Hemang Nakarani under the Semester Long Projects by DSC-DAIICT.

Please follow this guideline while contributing to the project,not adhering to these may result in loss of points.

General instructions

  • To start working on any issue, please comment under that issue and start working ONLY after Meet Patel or Hemang Nakarani assign you the issue.
  • If someone makes a PR without being assigned that issue, that PR won't be awarded any points and won't even be considered valid. We'll be putting up strict measures to ensure everyone gets fair chance to make contributions.
  • At a time only one issue will be assigned to one participant. Solve that and you can move forward with next one.
  • This project is very well in its initial stage, so we'd love your inputs about feature requests or ideas. Please keep making suggestions, we'll definitely hear you out. This group should thrive with healthy discussions. PLease follow the guidelines for issues.
  • Please prefer sending messages about the project in group only. This is also a general advice in open source. Do not hesitate to ask doubts in here. Personal texts only limit the reach of mentor and others stay uninformed about happenings in the project. However, you're welcome to talk about anything that's personal in the direct messages.

Git Commands to get you started

  1. Fork the repository .
  2. Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the clone button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

https://github.com/<your-username>/schooler.git
  1. Create a branch.

Change to the repository directory on your computer (if you are not already there):

cd schooler

Now create a branch using the git checkout command:

git checkout -b <your-name/feature/bug>

For example:

git checkout -b add-contributing

(The name of the branch does not need to have the word add in it, but it's a reasonable thing to include because the purpose of this branch is to add your name to a list.)

  1. Push changes to GitHub.

Push your changes using the command git push :

git push origin <add-your-branch-name>

replacing <add-your-branch-name> with the name of the branch you created earlier

Bug report

Reporting Bugs This section guides you through submitting a bug report for Schooler. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.

  • Before creating bug reports, please go through this list .
  • When you are creating a bug report, please include as many details as possible.
  • Fill out the required template, the information it asks for helps us resolve issues faster.

Submitting A Bug Report

  • Explain the problem and include the following details to help maintainers reproduce the problem:
  1. Use a clear and descriptive title for the issue to identify the problem -
  • Describe the exact steps which reproduce the problem in as many details as possible.
  1. Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior -
  • Explain which behavior you expected to see instead and why.
  • Include expected behavior and what went wrong.
  • Explain the steps to reproduce the behavior of the bug.
  1. The following infomation is a must -
  • Operating System - Windows,Linux or Mac.
  • Browser
  • Local installations
  1. Include screenshots and animated GIFs which show you following the described steps and clearly demonstrate the problem -
  • Adding a visual of the bugs helps pinpoint the issues being faced.

Template :

  • Title
  • Description
  • Hardware/Software details
  • Behavior

Feature enhancement/request

Name: Feature Request - "Name of feature"
About: "Explain in short . Please search for existing issues first . Also see CONTRIBUTING."

Please Describe The Problem To Be Solved

Add the feature you want to update/solve. Explain it in detail,how are you planning to implement it,how do you envision it to work,the problems it would solve.

Suggest A Solution

  • Replace This Text: A concise description of your preferred solution. Things to address include:
  • Details of the technical implementation
  • Tradeoffs made in design decisions
  • Caveats and considerations for the future

If there are multiple solutions, please present each one separately. Save comparisons for the very end.