Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (75 loc) · 2.27 KB

CONTRIBUTING.md

File metadata and controls

107 lines (75 loc) · 2.27 KB
Raw

Contributing to Inbox Archeology

Thanks for your interest in contributing.

Inbox Archeology is meant to be approachable for both technical and non-technical contributors. Small contributions are welcome.

Ways to contribute

You can help by:

  • reporting bugs
  • suggesting features
  • improving documentation
  • refining the UI
  • adding data visualizations
  • improving onboarding for first-time users
  • contributing code fixes or new features

Before you start

Please check the Issues tab for open tasks, ideas, and discussion topics.

Good places to begin:

  • issues labeled good first issue
  • issues labeled help wanted
  • documentation improvements
  • beginner-friendly UI polish

Development setup

git clone https://github.com/monapdx/Inbox-Archeology.git
cd Inbox-Archeology
npm install
npm run dev

Then open the local dev URL shown in your terminal.

Contribution workflow

  1. Fork the repository
  2. Create a new branch for your change
  3. Make your edits
  4. Test your changes locally
  5. Commit with a clear message
  6. Open a pull request

Pull request guidelines

Please try to keep pull requests:

  • focused on one change
  • clearly described
  • easy to review

Helpful things to include in a PR:

  • what changed
  • why it changed
  • screenshots, if the UI was updated
  • steps to test, if relevant

Suggestions for first contributions

Here are good starter contributions:

  • improve README clarity
  • add screenshots or GIFs
  • improve loading states
  • improve mobile responsiveness
  • add demo/sample data
  • add search or filter improvements
  • add export options

Code style

There is no need to be overly formal. Prioritize:

  • readability
  • small, understandable changes
  • clear variable names
  • minimal unnecessary complexity

Discussion and ideas

If you are not ready to submit code, that is completely fine.

You can still contribute by:

  • opening an issue
  • sharing feature ideas
  • suggesting UX improvements
  • discussing privacy/local-first design choices

Philosophy

This project is part of a broader effort around:

  • data portability
  • digital sovereignty
  • local-first tools
  • personal archives

Contributions that support those goals are especially welcome.

Questions

If you are unsure where to start, open an issue and describe what you want to help with.