Skip to content

Latest commit

 

History

History
76 lines (61 loc) · 4.42 KB

CONTRIBUTING.md

File metadata and controls

76 lines (61 loc) · 4.42 KB
Raw

Contributing to se_hw_LuaToPython

Legal Notice

When contributing to this project, you must agree that you have authored 100% of the content. You must own the rights to your content and it is your responsibility to make sure it complies with the Code of Conduct and Licence policies. Hello fellow contributor! We are glad that you have chanced upon our repository and chosen to contribute your valuable knowledge to it!

In case you don't wish to contribute but want to support us or know more, help us by:

  • Starring! We appreciate the love!
  • Cloning and Testing the Project out! Report any bugs or issues
  • Sharing/Tweeting/Grapevining - whichever mode of informating propagation you prefer! Kindly refer to the table of contents for any specific instructions or FAQs

Table of Contents

Sr no. Content
1 Question?
2 How To Contribute:
2.1 - Reporting Bugs
2.2 - Adding your Code
2.3 - Enhancing The README
3 Commit Messages
4 Join The Project Team

Question?

Hopefully the README.md answers any questions you may have, but if not, here are a few things you can do:

  • Look through the Issues section to see if your query has been answered previously. If you aren't satisfied with the explanation/answer - you can add on your doubts as a reply to the issue.
  • If you want to create a new issue for a previously unaddressed question, we suggest you to follow the given steps:
    • Open an Issue.
    • Write in detail about the problem and specify the code if possible.
  • The internet! - If you don't find help in any of the issues nor the documentation. We suggest you look throught the internet. Stackoverflow or framework documentations could be a real help! We will then take care of the issue as soon as possible.

How to Contribute:

Reporting Bugs

For reporting a bug, refer to the [Question?] part

Guidelines while reporting bugs:

  1. Use the GitHub search : check if the issue has already been found and reported.
  2. Check if the issue has been resolved : Pull it and run it to see if it resolves the bug you are trying to report
  3. Isolate the problem : create a reduced test case and a live example.

Things to remember while reporting a bug:

  1. It should have enough information so that other people don't have to ask you persistently.
  2. You should make sure you have checked versioning, SDK requirements, IDE, OS, size, browser requirements etc. before concluding that it is indeed a bug. Eg: 'It works on others systems and not mine' is not valid.

Adding your Code

Steps to add code to this repository:

  1. Open a pull request
  2. Make sure you only work on code after it has been made evident in the issues that a bug has not been fixed and you can better it.
  3. The changes you have made should be tested well and good and passed before being committed.
  4. Your commits should not be too many - Keep your commit history brief!
  5. Sell you code in the description of the PR and convince as to why we should add it.

Enhancing the README

As this is an example project meant for homework purposes, the README.md will be short and brief. Yet, there are ways in which the README can be enhanced:

  1. Styling
  2. Organizing content by means of tabularizing, aligning etc.
  3. Adding Media! Images, Videos, GIFS
  4. Adding Analytics that may help other coders
  5. Adding latest information that has been added via merged pull requests.

Commit Messages

Follow a few of these simple rules while creating a commit message for your code contribution:

  • Limit the subject line to 5-6 words
  • Capitalize the subject line
  • Limit the body to 9-10 words
  • In the body, describe what you have done and optionally, why

Join The Project Team

If you are interested in joining our project team, hit us up at (se-group-10@gmail.com) !