Skip to content

Latest commit

 

History

History
45 lines (36 loc) · 1.36 KB

CONTRIBUTING.md

File metadata and controls

45 lines (36 loc) · 1.36 KB
Raw

Contribution

You want to contribute to pass tomb, thank a lot for this. You will find in this page all the useful information needed to contribute.

How to run the tests?

pass-tomb has a complete test suite that provide functional and unit tests for all the parts of the program. Moreover, it provides test coverage and code health reports.

In order to run the tests, you need to install the following program(s):

  • kcov as coverage system for bash.

The tests require sudo access, and the generated tomb are written in /tmp/pass-tomb. To run the tests, simply run: make tests

How to contribute?

  1. If you don't have git on your machine, install it.
  2. Fork this repo by clicking on the fork button on the top of this page.
  3. Clone the repository and go to the directory:
git clone  https://github.com/this-is-you/pass-tomb.git
cd pass-import
  1. Create a branch:
git checkout -b my_contribution
  1. Make the changes and commit:
git add <files changed>
git commit -m "A message for sum up my contribution"
  1. Push changes to GitHub:
git push origin my_contribution
  1. Submit your changes for review: If you go to your repository on GitHub, you'll see a Compare & pull request button, fill and submit the pull request.