|
| 1 | +# Contributing to Privacy Activist Kit |
| 2 | + |
| 3 | +Thank you for considering contributing to the Privacy Activist Kit! This project exists to help people protect their digital privacy, and your contributions help make that mission stronger. |
| 4 | + |
| 5 | +## How You Can Help |
| 6 | + |
| 7 | +There are many ways to contribute, and you don't need to be a developer or security expert to make a meaningful impact: |
| 8 | + |
| 9 | +### 🌟 Non-Technical Contributions |
| 10 | + |
| 11 | +- **Star the repository** on GitHub to help others discover the project |
| 12 | +- **Share the project** on social media or with communities who might benefit |
| 13 | +- **Report broken links** or outdated information |
| 14 | +- **Suggest new tools or services** that align with the project's privacy-focused mission |
| 15 | +- **Improve readability** by fixing typos, clarifying language, or improving explanations |
| 16 | +- **Translate content** to make privacy resources accessible in more languages |
| 17 | +- **Share feedback** on what's working well or what could be improved |
| 18 | + |
| 19 | +### 📝 Content Contributions |
| 20 | + |
| 21 | +- **Add new guides** on privacy topics not yet covered |
| 22 | +- **Update existing content** with current best practices |
| 23 | +- **Create checklists** for specific use cases or threat models |
| 24 | +- **Write beginner-friendly explanations** of technical concepts |
| 25 | +- **Add real-world examples** to help illustrate privacy concepts |
| 26 | + |
| 27 | +### 🔧 Technical Contributions |
| 28 | + |
| 29 | +- **Fix bugs** in the website or documentation |
| 30 | +- **Improve site performance** or accessibility |
| 31 | +- **Add new features** to the VitePress site |
| 32 | +- **Optimize images** and other assets |
| 33 | +- **Improve SEO** and discoverability |
| 34 | + |
| 35 | +## Getting Started |
| 36 | + |
| 37 | +### Reporting Issues |
| 38 | + |
| 39 | +Found a problem? [Open an issue](https://github.com/Turtlecute33/PrivacyActivistKit/issues) with: |
| 40 | + |
| 41 | +- A clear, descriptive title |
| 42 | +- A detailed description of the issue |
| 43 | +- Steps to reproduce (if applicable) |
| 44 | +- Expected vs. actual behavior |
| 45 | +- Screenshots (if relevant) |
| 46 | + |
| 47 | +### Making Changes |
| 48 | + |
| 49 | +1. **Fork the repository** to your own GitHub account |
| 50 | +2. **Clone your fork** locally: |
| 51 | + ```bash |
| 52 | + git clone https://github.com/YOUR-USERNAME/PrivacyActivistKit.git |
| 53 | + cd PrivacyActivistKit |
| 54 | + ``` |
| 55 | +3. **Install dependencies**: |
| 56 | + ```bash |
| 57 | + npm install |
| 58 | + ``` |
| 59 | +4. **Create a branch** for your changes: |
| 60 | + ```bash |
| 61 | + git checkout -b your-branch-name |
| 62 | + ``` |
| 63 | +5. **Make your changes** and test them locally: |
| 64 | + ```bash |
| 65 | + npm run docs:dev |
| 66 | + ``` |
| 67 | +6. **Commit your changes** with a clear, descriptive message: |
| 68 | + ```bash |
| 69 | + git commit -m "Add brief description of your changes" |
| 70 | + ``` |
| 71 | +7. **Push to your fork**: |
| 72 | + ```bash |
| 73 | + git push origin your-branch-name |
| 74 | + ``` |
| 75 | +8. **Open a Pull Request** from your fork to the main repository |
| 76 | + |
| 77 | +## Content Guidelines |
| 78 | + |
| 79 | +When contributing content to the Privacy Activist Kit, please follow these principles: |
| 80 | + |
| 81 | +### Voice and Tone |
| 82 | + |
| 83 | +- **Clear and accessible**: Write for a general audience, not just technical experts |
| 84 | +- **Direct and practical**: Focus on actionable advice people can implement |
| 85 | +- **Empowering, not preachy**: Help people make informed choices without judgment |
| 86 | +- **Honest about trade-offs**: Privacy often involves balancing security, convenience, and usability |
| 87 | + |
| 88 | +### Technical Standards |
| 89 | + |
| 90 | +- **Accuracy first**: Verify information from reliable sources before adding it |
| 91 | +- **Keep it current**: Privacy tools and best practices change frequently—date-sensitive content when appropriate |
| 92 | +- **Cite sources**: Link to official documentation, research papers, or trusted organizations |
| 93 | +- **Test recommendations**: Only recommend tools you've researched or used yourself |
| 94 | + |
| 95 | +### Practical Considerations |
| 96 | + |
| 97 | +- **Consider diverse threat models**: What works for one person may not work for another |
| 98 | +- **Respect different risk levels**: Not everyone faces the same threats |
| 99 | +- **Avoid assumptions**: Don't assume technical knowledge, financial resources, or specific devices |
| 100 | + |
| 101 | +### What NOT to Include |
| 102 | + |
| 103 | +- **Affiliate links or sponsored content**: This project is independent and ad-free |
| 104 | +- **Untested or experimental tools**: Stick to well-established, trusted solutions |
| 105 | +- **Illegal activities**: Focus on defensive security, not offensive techniques |
| 106 | +- **Fear-mongering**: Be honest about risks without creating unnecessary panic |
| 107 | +- **Personal opinions as facts**: Clearly distinguish recommendations from personal preferences |
| 108 | + |
| 109 | +## Code of Conduct |
| 110 | + |
| 111 | +This project is committed to providing a welcoming environment for all contributors. Please read and follow our [Code of Conduct](CODE_OF_CONDUCT.md). |
| 112 | + |
| 113 | +## License |
| 114 | + |
| 115 | +By contributing to this project, you agree that your contributions will be licensed under the [Creative Commons Attribution-NonCommercial 4.0 International License](LICENSE). |
| 116 | + |
| 117 | +This means: |
| 118 | +- Your contributions can be freely shared and adapted |
| 119 | +- You will be credited for your work |
| 120 | +- The project will remain non-commercial |
| 121 | + |
| 122 | +## Questions? |
| 123 | + |
| 124 | +If you have questions about contributing, feel free to: |
| 125 | +- [Open an issue](https://github.com/Turtlecute33/PrivacyActivistKit/issues) for discussion |
| 126 | +- Reach out through the project's communication channels |
| 127 | + |
| 128 | +Thank you for helping make digital privacy accessible to everyone! ✨ |
0 commit comments