mirror of
https://github.com/maybe-finance/maybe.git
synced 2025-07-19 05:09:38 +02:00
Improve Local Dev Setup Documentation and Contribution Guidelines (#339)
* Update contributing guide and README * Add back syntax highlighting
This commit is contained in:
parent
b8198d17b7
commit
ae241c29f0
2 changed files with 66 additions and 34 deletions
|
@ -2,12 +2,39 @@
|
|||
|
||||
It means so much that you're interested in contributing to Maybe! Seriously. Thank you. The entire community benefits from these contributions!
|
||||
|
||||
Before submitting a new issue or PR, check if it already exists in [issues](https://github.com/maybe-finance/maybe/issues) or [PRs](https://github.com/maybe-finance/maybe/pulls) so you have an idea of where things stand.
|
||||
## House Rules
|
||||
|
||||
Then, once you're ready to begin work, submit a draft PR with your high-level plan (or the full solution).
|
||||
- Before contributing, please check if it already exists in [issues](https://github.com/maybe-finance/maybe/issues) or [PRs](https://github.com/maybe-finance/maybe/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.
|
||||
|
||||
Given the speed at which we're moving on the codebase, we don't assign issues or "give" issues to anyone.
|
||||
## What should I contribute?
|
||||
|
||||
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.
|
||||
As we are still in the early days of this project, we recommend [heading over to the Wiki](https://github.com/maybe-finance/maybe/wiki) to get a better idea of _what_ to contribute.
|
||||
|
||||
Priority is also generally given to previous committers as they've proven familiarity with the codebase and product.
|
||||
In general, _full features_ that get us closer to [our Vision](https://github.com/maybe-finance/maybe/wiki/Vision) are the most valuable contributions at this stage.
|
||||
|
||||
## Development
|
||||
|
||||
### Setup
|
||||
|
||||
To get setup for local development, you have two options:
|
||||
|
||||
1. [Dev Containers](https://code.visualstudio.com/docs/devcontainers/containers) with VSCode (see the `.devcontainer` folder)
|
||||
2. Local Development
|
||||
- [Mac Setup Guide](https://github.com/maybe-finance/maybe/wiki/Mac-Dev-Setup-Guide)
|
||||
- [Linux Setup Guide](https://github.com/maybe-finance/maybe/wiki/Linux-Dev-Setup-Guide)
|
||||
- [Windows Setup Guide](https://github.com/maybe-finance/maybe/wiki/Windows-Dev-Setup-Guide)
|
||||
|
||||
### 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.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue