Skip to content

Latest commit

 

History

History
54 lines (38 loc) · 3.3 KB

CONTRIBUTING.md

File metadata and controls

54 lines (38 loc) · 3.3 KB
Raw

How do I Contribute?

  1. Fork the repository
  2. Clone it to your local system
  3. Identify which issue you want to work upon,SEARCH IN THE ISSUES SECTION IF THAT ISSUE IS ALREADY ASSIGNED TO SOMEONE. IF NOT, THEN UPLOAD WHAT YOU WANT TO DO AS AN ISSUE. And then perform changes based on that issue only
  4. Commit your changes and include a clear commit message that is very specific about the issue you've worked upon/resolved
  5. Try and resolve separate issues in different commits
  6. Send a Pull Request
  7. Your PR's will be reviewed and merged if found to be satisfactory

Technologies used (simple tutorials provided as links)

Best practices for contribution

Anyone can contribute to our open source project, so feel free to do it. But make sure that you follow certain practices which include:

  1. Make sure that git commit messages are meaningful, easy to understand and extremely specific: for e.g. 'Fixed Submit button not working properly on the user dashboard page'.
  2. Each Pull Request(PR) must solve one issue mentioned in our issues page. In case your PR is solving any bug that is not mentioned in the issues page, then open one issue explaining the bug and then make a PR with reference to that issue.
  3. While solving an issue you must make one comment saying that you are working on that issue so that we can avoid any conflict.
  4. While making a PR make sure you reference your issue id (#1, #2 etc.) in the commit message or title.
  5. Make sure you squash your commit if there are more than 2 commits in your Pull Request. In case of difficulties feel free to ask for any assistance.
  6. While making any Pull Request for the UI make sure you attach one screenshot & one link to your version's site showing the final result or the bug which you have solved.
  7. While creating any issue make sure you mention all the procedures required to generate that bug/error and have one brief description about that bug.
  8. Last but not the least, ALWAYS follow standard coding practices, naming conventions and the regular document object model (DOM).

Example of Right and Wrong Approach.

Suppose we raise a bug that page is not being responsive. What does it mean?

We like the design. Do not change the design.

  WRONG APPROACH: For example: You don't like the fonts, you change it?
  CORRECT APPROACH: Our page is not being responsive, you fix it, with all the initial design, fonts,
                    and colors.

  WRONG APPROACH: You want to add a feature, you just add it.
  CORRECT APPROACH: You want to add a feature, you ask the moderators if they want that, host the
  files in your github repo and submit github pages here in the comments below. After we review,
  you can send a PR request, and we will definitely accept it. :) Cheers !!

NOTE:- Failing to follow the guidelines properly may result closing the Pull Request
The TaskMaster Team