diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..7fbde354 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,28 @@ +# Contributing to Maybe + +It means so much that you're interested in contributing to Maybe! Seriously. Thank you. The entire community benefits from these contributions! + +## House Rules + +- Before contributing, please check if it already exists in [issues](https://github.com/maybe-finance/marketing/issues) or [PRs](https://github.com/maybe-finance/marketing/pulls) +- Given the speed at which we're moving on the codebase, we don't assign issues or "give" issues to anyone. +- When multiple PRs are submitted for the same issue, we take the one that most succinctly & efficiently solves a given problem and stays within the scope of work. +- Priority is generally given to previous committers as they've proven familiarity with the codebase and product. + +## Development + +### Setup + +To get setup for local development, we recommend using [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) with VSCode (see the `.devcontainer` folder). + +### Making a Pull Request + +1. Fork the repo +2. Create your feature branch (`git checkout -b my-new-feature`) +3. Commit your changes (`git commit -am 'Add some feature'`) +4. Push to the branch (`git push origin my-new-feature`) +5. Create new Pull Request, and be sure to check the [Allow edits from maintainers](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/allowing-changes-to-a-pull-request-branch-created-from-a-fork) option while creating your PR. This allows maintainers to collaborate with you on your PR if needed. +6. If possible, [link your pull request to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) by adding the appropriate keyword (e.g. `fixes issue #XXX`) +7. Before requesting a review, please make sure that all [Github Checks](https://docs.github.com/en/rest/checks?apiVersion=2022-11-28) have passed and your branch is up-to-date with the `main` branch. After doing so, request a review and wait for a maintainer's approval. + +All PRs should target the `main` branch. diff --git a/README.md b/README.md index 13ade978..af346c65 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,25 @@ +# Maybe Marketing Site + This is the marketing site for Maybe, an OS for your personal finances. +## Local Development Setup + +### Requirements + +- Ruby >3 (see `Gemfile`) +- PostgreSQL >9.3 (ideally, latest stable version) + +After cloning the repo, the basic setup commands are: + +```sh +cd marketing +cp .env.example .env +bin/setup +bin/dev +``` + +Then visit http://localhost:3000 to see the app. + ## Copyright & license Maybe is distributed under an [AGPLv3 license](https://github.com/maybe-finance/maybe/blob/main/LICENSE). "Maybe" and the stacked "M" logo are trademarks of Maybe Finance, Inc. diff --git a/app/assets/images/screenshot.png b/app/assets/images/screenshot.png new file mode 100644 index 00000000..df92539d Binary files /dev/null and b/app/assets/images/screenshot.png differ