Skip to content

Latest commit

 

History

History
49 lines (29 loc) · 2.44 KB

CONTRIBUTING.md

File metadata and controls

49 lines (29 loc) · 2.44 KB

Contributing to flatnotes

Thank you for your interest in contributing to flatnotes.

At this time, pull requests are disabled. I really appreciate that people care enough about the project to want to improve it, so I want to explain why this is the case and how I’m approaching development.

Project principles

flatnotes is designed to be a distraction-free note‑taking app that puts your content first. A key principle of this is to avoid feature bloat and keep the app predictable and lightweight. Sticking to these principles often means saying “no” to new features, even good ones.

Why pull requests are disabled

There are two main reasons:

  1. Maintaining the project’s direction
    To keep flatnotes simple and consistent with its original design principles, I need to be very deliberate about any changes that go in. Reviewing and aligning external contributions with this vision can take a lot of time and discussion.

  2. Limited personal time
    I don’t have a lot of free time to work on flatnotes. The time I do have, I want to spend on:

    • Maintenance
    • Bug fixing
    • Keeping existing features stable and reliable

Managing and reviewing pull requests (even good ones) is often more time‑consuming than implementing small, focused changes myself.

Because of this, I’ve decided that for now it’s best to disable pull requests and keep development tightly scoped.

How you can still help

Even though PRs are disabled, there are still ways you can support the project:

  • Report bugs
    Clear, reproducible bug reports are extremely helpful and directly support the maintenance focus of the project.

  • Share feedback
    While I’m not looking to add lots of new features, feedback on existing behaviour, usability issues and suggestion are still valuable.

  • Use and share flatnotes
    Simply using the app and recommending it to others helps keep the project alive and motivates further maintenance.

  • Sponsorship
    If you find flatnotes useful, sponsoring the project is a great way to show support and helps justify the time I spend maintaining it.

Thank you

I’m genuinely grateful to anyone who takes the time to engage with flatnotes, whether by using it, reporting issues, or just expressing interest in contributing. Even though I’m not accepting pull requests at this time, that interest means a lot and helps keep the project going.

Thank you for your understanding.