Skip to content
This repository was archived by the owner on Jul 27, 2025. It is now read-only.

Project Management and Release Cycle

Jump to bottom
Zach Gollwitzer edited this page May 21, 2024 · 4 revisions

We're in "test mode" with the project management side of things, so everything here is subject to change. That said, below are some general guidelines on how we'll be working moving forward as a community:

Roadmap

You can find the roadmap here:

https://github.com/orgs/maybe-finance/projects/13

This is a high-level overview of where the project is going in the near term. Due to the early stage of this project, all timelines are best guesses and subject to change.

Projects

You can find all of our currently active projects here:

https://github.com/orgs/maybe-finance/projects?query=is:open

We are defining a "project" as:

Example: "Transaction Management"

  • A group of ideas/issues related to a single "module" of the app
  • Some projects will be ongoing with no due date; others will be highly specific within a short timeframe

Milestones, Releases, Packages

  • A "milestone" maps 1:1 with a "release" tag. For example, v0.2.0-alpha is a milestone we work towards that will eventually be released.
  • A milestone will include cherry-picked issues across one or more projects.
  • During this alpha phase of development, we will generally be using the following tagging convention:
    • v0.X.0-alpha - a "milestone"
    • v0.X.0-alpha.X - an iteration towards a milestone. For example, v0.1.0-alpha.1 -> v0.1.0-alpha.2 -> v0.2.0-alpha (milestone)
    • v1.0.0 will be our first "general release" (stable)

Relevant links:

How to request features

We have created a feature request template in Discussions. You can find it here:

https://github.com/maybe-finance/maybe/discussions/new?category=feature-requests

We unfortunately cannot accept all feature requests. For the best chance at getting your feature request on the roadmap, follow the guidelines below:

  • A feature request should benefit a large group of users.
  • A feature request should be specific with examples, links, and any other context that helps us understand what you are asking for.
  • If you see a feature you like, upvote it so we can see! The more upvotes a feature request gets, the higher the likelihood that it will make it on the roadmap.

How to contribute effectively

There are three primary types of contributions that are most valuable to this project right now:

Bug Reports and Fixes

Bug reports and fixes are incredibly valuable to us! Due to the fast-moving nature of this project, there are plenty of them to go around. If you are looking to contribute but don't know where to start, we recommend:

  1. Get your self-hosted instance running.
  2. Click through the app and use it.
  3. Report any bugs that you find.
  4. Once we confirm it is a bug, you're more than welcome to dive in and fix it! 🐛

Improvements

While we do our best to write clean code, this project is simply moving too fast to get it all right. If you see something that looks wrong, open up an issue and let's discuss it! Performance improvements, security improvements, and full feature refactors are welcome.

Scoped Feature Work

While we generally will NOT accept new features without prior discussion, we do our best to keep our projects updated and frequently publish new feature-related issues that are ready to be built.

How do I know what's ready to be worked on?

  • If it has a bounty on it, go for it!
  • If it is an open issue and is in the Ready column of any of our projects, go for it!
  • If you're unsure, just comment on the issue and ask

WIP Footer

WIP Sidebar

Clone this wiki locally