Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 3.51 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 3.51 KB
Raw

Contributing to Jeevanrakht

JeevanRakht is a web application based on MongoDB, node.js and express.js stack and we are using jQuery and JavaScript for client side scripting. In future, we are planning to migrate to MEAN stack and include Angular to our APP. We do have static website page as well where you can know more about us.

General Guidelines

  • Add assets such as images and other media in assets folder.
  • Follow standard coding practises, naming conventions and the regular document object model (DOM).
  • Make issues on GitHub to propose new features, bugs and then make a PR referencing the same.
  • Make sure you update your REMOTE ORIGIN in case you have forked this repo : Refer
  • Once you update the forked repo make sure you rebase the changes and then open the PR. Refer

Submitting Issues

  • Before creating a new issue, perform a cursory search in the main jeevanrakht repos to see if a similar issue has already been submitted.
  • You can create an issue here. Please include as many details as possible in your report.
  • Issue titles should be descriptive, explaining at the high level what it is about.
  • Please include the version of Gulp, Node, and NPM you are using, as well as what operating system you are having a problem on.
  • Do not open a pull request to resolve an issue without first receiving feedback from a collaborator or owner and having them agree on a solution forward.
  • Include screenshots and animated GIFs whenever possible; they are immensely helpful.

Pull Requests

  • DO NOT ISSUE A PULL REQUEST WITHOUT FIRST SUBMITTING AN ISSUE
  • It is now mandatory for everyone to comment on every PR made and read other people's code.
  • Pull requests should reference their related issues. If the pull request closes an issue, please reference its closing in your commit messages. Pull requests not referencing any issues will be closed.
  • Pull request titles should be descriptive, explaining at the high level what it is doing, and should be written in the same style as Git commit messages.
  • Follow our JavaScript styleguides. Tests will fail if you do not.
  • Every PR should only have one logical change and the least number of commits possible (If for some reasons the commits are higher then the creator of the PR would be asked to squash them.) If he/she doesn't comply, then PR is not to be merged.
    Refer in case there are multiple commits.
  • Do not squash or rebase your commits(with multiple logical changes) when submitting a Pull Request. It makes it much harder to follow your work and make incremental changes.
  • Branches should be made off of the most current master branch from https://github.com/UdacityFrontEndScholarship/jeevan-rakht.git
  • Pull requests should be made into our master branch.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added Feature")
  • Use the imperative mood ("Move cursor to…" not "Moves cursor to…")
  • Limit the first line to 72 characters or less