Skip to content

Consolidate docs #624

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Consolidate docs #624

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/Development-Guidelines.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# PranaDB development guidelines

## Core team

### Significant pieces of work

* If you're starting work on a task that's going to take longer than a few days, best to create a short one pager document to outline the design approach that's going to be taken. This gives everyone a chance to discuss it.

### Approach to PRs

* When reviewing PRs, don't be pedantic or obsess over cosmetic things or code style. If the PR is more or less right and just needs some small changes, prefer to approve with some notes so the author can apply the changes themselves and merge. Uber's [Go Style Guide](https://github.com/uber-go/guide/blob/master/style.md) is a good resource of idiomatic code snippets that we can point to for small review nits.
* We are a globally distributed team and it's important that we don't get blocked due to timezones. If you submit a PR at the end of your working day, the other team members should try to review it before you start work the next day. If it hasn't been reviewed, feel free to merge it yourself. We value trust over perfection and any needed changes can be applied later.
* If you have a really trivial change in a PR (cosmetic, one liner), unless it's super quick to get someone to stamp the PR, feel free just to merge it yourself.

## External Contributors

Thank you for your interest in contributing to PranaDB!

* You will need to sign the [Block CLA](https://docs.google.com/forms/d/e/1FAIpQLSeRVQ35-gq2vdSxD1kdh7CJwRdjmUA0EZ9gRXaWYoUeKPZEQQ/viewform?formkey=dDViT2xzUHAwRkI3X3k5Z0lQM091OGc6MQ&ndplr=1) in order to contribute
* If you are interested in doing some development, we suggest first trying a simple task - these are marked with "Good First Issue" in [GitHub issues](https://github.com/cashapp/pranadb/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)
* If you're confident to tackle something more complex, we suggest first commenting on the issue to show your interest and we can take it from there.

Loading