Thank you for helping improve Cryptomator's documentation!
- Fork the repository
- Clone your fork:
git clone <your-fork-url> - Install dependencies:
npm install - Start development server:
npm start
- Documentation files are in the
docs/folder - Use clear, concise language
- Include screenshots or examples where helpful
- Test your changes locally before submitting
We follow git flow for contributions:
- Create a feature branch:
git checkout -b feature/improve-docs - Make your changes and commit:
git commit -m "Improve setup instructions" - Push to your fork:
git push origin feature/improve-docs - Open a pull request
Note: Branch names and commit messages above are examples. Use descriptive names that reflect your actual changes.
- Keep content up-to-date with the latest app versions
- Use consistent formatting and style
- Break up long sections with headings and lists
- Link to related documentation when relevant
Help us keep Cryptomator open and inclusive. Please read and follow our Code of Conduct.
Thank you for taking the time to contribute to the project! 👍
Cryptomator Team