Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 1.56 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.56 KB

How to contribute

The community is essential to spread the bliss of development. We improve our open source libraries as far as we need to use them in our projects. But we can't think of all the use cases you might have. So we'd like to have you participating in our bliss. We want to keep it as easy as possible to contribute changes. There are just a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things.

Testing

simply run make test

There should be no failed tests, no avoidable pragma: nocover comments and 100% coverage.

Writing issues

  • Submit a new ticket for your issue, assuming one does not already exist.
  • Clearly describe the issue including, in the case of bugs, steps to reproduce it.

Making Changes

  • Fork this repository into your own github account
  • Create a local copy of that repository on your machine.
  • Make commits of logical units. git add {file}; git commit -m "{commit message}"
  • Make sure your commit messages are informative.
  • Make sure you have added the necessary tests for your changes.
  • Run tests to ensure nothing else was broken accidentally. make test

Submitting Changes

  • Push your changes to the topic branch in your fork of the repository. git push origin {branchname}
  • Submit a pull request to the repository in the devbliss organization. see this link
  • Write an informative pull request description.
  • Please don't add information to changelog.md.