Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
133 lines (100 loc) · 5.13 KB

CONTRIBUTING.md

File metadata and controls

133 lines (100 loc) · 5.13 KB

Contributing to Privacy Activist Kit

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.

How You Can Help

There are many ways to contribute, and you don't need to be a developer or security expert to make a meaningful impact:

🌟 Non-Technical Contributions

  • Star the repository on GitHub to help others discover the project
  • Share the project on social media or with communities who might benefit
  • Report broken links or outdated information
  • Suggest new tools or services that align with the project's privacy-focused mission
  • Improve readability by fixing typos, clarifying language, or improving explanations
  • Translate content to make privacy resources accessible in more languages
  • Share feedback on what's working well or what could be improved

📝 Content Contributions

  • Add new guides on privacy topics not yet covered
  • Update existing content with current best practices
  • Create checklists for specific use cases or threat models
  • Write beginner-friendly explanations of technical concepts
  • Add real-world examples to help illustrate privacy concepts

🔧 Technical Contributions

  • Fix bugs in the website or documentation
  • Improve site performance or accessibility
  • Add new features to the VitePress site
  • Optimize images and other assets
  • Improve SEO and discoverability

Getting Started

Reporting Issues

Found a problem? Open an issue with:

  • A clear, descriptive title
  • A detailed description of the issue
  • Steps to reproduce (if applicable)
  • Expected vs. actual behavior
  • Screenshots (if relevant)

Making Changes

  1. Fork the repository to your own GitHub account using the Fork button on GitHub

  2. Clone your fork locally (replace YOUR-USERNAME with your actual GitHub username):

    git clone https://github.com/YOUR-USERNAME/PrivacyActivistKit.git
cd PrivacyActivistKit

    Or clone the main repository directly if you just want to preview locally:

    git clone https://github.com/Turtlecute33/PrivacyActivistKit.git
cd PrivacyActivistKit

  3. Install dependencies:

    npm install

  4. Create a branch for your changes:

    git checkout -b your-branch-name

  5. Run the development server to preview your changes:

    npm run docs:dev

    This will start VitePress dev server at http://localhost:5173/

  6. Make your changes - the site will auto-reload as you edit files

  7. Commit your changes with a clear, descriptive message:

    git commit -m "Add brief description of your changes"

  8. Push to your fork:

    git push origin your-branch-name

  9. Open a Pull Request from your fork to the main repository

Content Guidelines

When contributing content to the Privacy Activist Kit, please follow these principles:

Voice and Tone

  • Clear and accessible: Write for a general audience, not just technical experts
  • Direct and practical: Focus on actionable advice people can implement
  • Empowering, not preachy: Help people make informed choices without judgment
  • Honest about trade-offs: Privacy often involves balancing security, convenience, and usability

Technical Standards

  • Accuracy first: Verify information from reliable sources before adding it
  • Keep it current: Privacy tools and best practices change frequently—date-sensitive content when appropriate
  • Cite sources: Link to official documentation, research papers, or trusted organizations
  • Test recommendations: Only recommend tools you've researched or used yourself

Practical Considerations

  • Consider diverse threat models: What works for one person may not work for another
  • Respect different risk levels: Not everyone faces the same threats
  • Avoid assumptions: Don't assume technical knowledge, financial resources, or specific devices

What NOT to Include

  • Affiliate links or sponsored content: This project is independent and ad-free
  • Untested or experimental tools: Stick to well-established, trusted solutions
  • Illegal activities: Focus on defensive security, not offensive techniques
  • Fear-mongering: Be honest about risks without creating unnecessary panic
  • Personal opinions as facts: Clearly distinguish recommendations from personal preferences

License

By contributing to this project, you agree that your contributions will be licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.

This means:

  • Your contributions can be freely shared and adapted
  • You will be credited for your work
  • The project will remain non-commercial

Questions?

If you have questions about contributing, feel free to:

  • Open an issue for discussion
  • Reach out through the project's communication channels

Thank you for helping make digital privacy accessible to everyone! ✨