Thank you for considering contributing to LoggedFS-python! Contributions are highly welcomed!
Issues are tracked on Gitbub.
- Describe what you expected to happen.
- If possible, include a minimal, complete, and verifiable example to help identify the issue. This also helps check that the issue is not with your own code.
- Describe what actually happened. Include the full traceback if there was an exception.
- Add log files if possible. Careful, they tend to be huge.
- List your operating system, Python, FUSE and LoggedFS-python versions. If possible, check if this issue is already fixed in the repository (development branch).
- Run
make testbefore submission and indicate which tests the file-system now passes that did worked before. - Use tabs for indentation.
- No, there is no line limit. Let your editor wrap the lines for you, if you want.
- Add as many comments as you can - code-readability matters.
- The
masterbranch is supposed to be stable - request merges into thedevelopbranch instead. - Commits are preferred to be signed (GPG). Seriously, sign your code.
- Make sure you have FUSE installed and working.
- Download and install the latest version of git.
- Configure git with your username and email:
git config --global user.name 'your name'
git config --global user.email 'your email'- Make sure you have a GitHub account.
- Fork LoggedFS-python to your GitHub account by clicking the Fork button.
- Clone your GitHub fork locally:
git clone https://github.com/{username}/loggedfs-python
cd loggedfs-python- Add the main repository as a remote to update later:
git remote add pleiszenburg https://github.com/pleiszenburg/loggedfs-python
git fetch pleiszenburg- Create a virtualenv:
python3 -m venv env
. env/bin/activate- Install LoggedFS-python in editable mode with development dependencies.
make install_link- Check the installation by testing it:
make test