B.E.N.J.I. for students or mentees

Hello, Mentees!

Your contribution to B.E.N.J.I. will certainly help you a lot. Especially in open-source

But you need to follow a few guidelines too:

• Do not ping your mentor repeatedly. He/She might be busy with other commitments too. If you think your mentor is not reviewing your PR, ping him/her in intervals of a week. If the mentor does not reply after two pings, ping the maintainer(me) straight away and I will review the PR.

• Before asking a doubt, try to search it on Google or StackOverFlow. Sometimes, our doubts are so trivial that even Google can answer them!

• Do not review a PR. Be it your friend, your partner or your sibling or whatever; do not review his/her PR. We have mentors and the maintainer to do that. In case, you reviewed:

  • For the first time, you will be warned
  • For the second time, a strong warning will be given.
  • For the third time, you will be banned

• Please don't indulge in informal conversation like "bro" or "fam".This is GitHub, not Facebook or Tinder.

• Make sure to read the code-of-conduct.md and the readme.md before contributing.

• When a mentor or the maintainer reviews a PR, you are expected to bring those changes first and then ping the maintainer.

• Update your forked projects regularly. If you don't do that, you are going to have a lot of merge conflicts coming up.

• Do not send PRs regarding a typo or line-break. It will be frowned upon. Secondly, while sending a PR, please describe what did you do to make a PR: in 3-4 sentences at most.

• If sending PRs that have new features for B.E.N.J.I., please try to put a .gif video of your feature working on your system.

• In case, you are having problems from the mentors or anyone else, feel free to contact the maintainer(me). I generally reply within 24 hours.

• Please prepare your documentation regularly. Open source is not an end semester exam where you do everything on the last night.

Hope you enjoy contributing to B.E.N.J.I. !