Skip to content

Contributing

Thank you for thinking about contributing to EnjuFolio 💫
This project (and these docs) are meant to stay small, understandable, and friendly, and contributions of all sizes help.

How you can help

There are a few easy ways to contribute:

  • Improve documentation

    • Fix typos, unclear sentences, or outdated examples
    • Add small notes where the behavior wasn’t obvious to you
    • Suggest better structure for a page
  • Report issues

    • Open a bug report if something does not work as expected
    • Share configuration or content edge cases you ran into
  • Send pull requests

    • Small refactors that improve readability
    • Accessibility or UX improvements
    • New examples that fit the existing design

If you’re not sure whether an idea fits, you can always start with an issue first.

Docs-specific contributions

For documentation changes, the easiest path is:

  1. Open a Documentation Update issue
    – use the “📚 Documentation Update” template so we understand the context.
  2. Optionally follow up with a PR referencing that issue.

You’ll find the “Suggest an improvement” link at the bottom of every docs page.

For local editing of docs and configuration, see:

Code contributions

For code or styling changes in EnjuFolio itself:

  1. Check existing issues (and open a new one if needed)

  2. Fork the repo and create a feature branch

  3. Install & run locally:

    bash
    pnpm install
    pnpm dev
  4. Keep the codebase consistent:

    bash
    pnpm lint
    pnpm lint:fix
  5. Open a PR with a clear title and a short description (follow the template) of what changed and why.

Small, focused PRs are much easier to review than big batches of changes.

Thank you 💛

EnjuFolio started as a personal project and is growing with the help of everyone who reads, tests, and improves it.

  • Every issue, suggestion, and typo fix is appreciated.
  • The list of contributors on GitHub reflects everyone who has directly pushed the project forward.

If you’re reading this section and considering a contribution, you’re already part of the story.

Contributors

The contents of this documentation site are Licensed under CC BY 4.0