-
Notifications
You must be signed in to change notification settings - Fork 1
Team Guides
This guide is for active team members and contributors. If that's not you, keep on swimming.
You may not change this document without the approval of the core contributing team.
We build this to better the world.
We must not let this be used for evil.
You must keep this top of mind at all times.
An autonomous agent(s) capable of accomplishing tasks on its own.
The average joe who wants to improve their life's lot.
We use our GH project boards to manage most of the projects. We also use Discord for communication and various drawing tools for collaboration.
If you create an issue, fill the template out.
We do code reviews for all changes.
- Discuss an issue
- Propose a fix to the team (unless you are the maintainer of that region of code)
- Open a PR
- Be respectful of your reviewers and fix the things discussed
- As a reviewer, if you have a small or minor nitpick, use
nit:
before your comment. These issues aren't worthy of blocking the PR but they bother the hell out of you. - As an author, if you don't fix a nit, convert it to an issue and put it in the backlog and label it
help wanted
.
- Only make one conceptual change per PR. I don't care if you're internal, external, or Toran himself. You must follow this.
- Your tests must pass to merge.
- You must retain backward compatibility for user-facing changes or have an announcement announcing the changes in advance.
- You must give and get real reviews.
- You must not reduce the coverage by more than 5% overall.
Externally, we enforce a strict requirement of filling out the PR details. Internally, I'd appreciate it if you did.
This governs our expectations around communication, processes, and more
You are expected to work with the team in a healthy and collaborative way. You may be asked to join meetings, be flexible. We are as globally distributed as possible. You are expected to communicate your working areas when you start working on them, not just before you open the PR.