This document contains information of use to partners looking to improve the BIFFUD's corporate documentation. See README.md for a sense of the purpose of this repository.
You should also look at the Corporate Bylaws which lays out some of the processes around the repository.
This repository has a home on GitHub. Please submit pull requests (PRs) there.
Please submit changes via pull request, even if you have direct commit access to the repository. The PR process allows us to get additional eyes on change proposals and gives us all a chance for corporate amusement.
Generally, the more controversial, complex or large a change, the more opportunity people should have to comment on it. That means it should garner more comments/approvals or it means it should sit longer before being merged.
Note: Some types of PR require a vote by the corporate overlords. for instance approval of minutes or project applications. Others can be merged by the Secretary of Code, Overmind, or Undermind.
Issues are used for keeping track of corporate tasks as well as for tracking various types of application.
Applications covered by issues:
- Project applications
- Corporate Overlord applications
- Requested budget changes
- Expense requests
More detail for each of these tasks is provided later in this document.
The wiki is the shared knowledge base of BIFFUD. It provides a public index of projects and BIFFUD overlords as well as information about how to go about using the various tools that we use as an organization.
The repository represents reality and canonical truth. The wiki should be seen as a helpful, lucid dream.
We will have a few "perma" branches that will always exist and are maintained by the appropriate elected role:
- order: this branch is for serious business such as contracts and legal documentation. It is managed by the Overmind and Undermind.
- code: this branch is for repo infrastructure and changes to code related documentation. It is managed by the Secretary of Code.
- treasure: this branch is for tracking budgets and expenses. It is managed by the Treasure Goblin.
- lore: this branch is for tracking documentation and minutes. It is managed by the Keeper of Lore.
- projects: this branch is for keeping track of projects and relevant documents or agreements. It is managed by the Beastmaster.
- popularity: this branch is for keeping track of communications and marketing materials such as emoji, logos, and catch phrases. It is managed by The Popular One.
- chaos: this branch is for chaos. It will hopefully never be merged. It is managed by all of the corporate overlords.
There shouldn't be any other branches than these. If something doesn't fit into any of these branches, open an issue.
REBASES AND FORCE PUSHES ON ANY BRANCH ARE FOR THE WEAK. LIVE WITH YOUR MISTAKES FOR THE WORLD TO SEE INDEFINITELY.
Please adhere to these guidelines for each commit message. The "Seven Rules" described in that post are:
- Separate subject from body with a blank line
- Limit the subject line to 50 characters
- Capitalize the subject line
- Do not end the subject line with a period
- Use the imperative mood in the subject line
- Wrap the body at 72 characters
- Use the body to explain what and why vs. how
Think of the commit message as an introduction to the change. A reviewer will read the commit message right before reading the diff itself, so the commit message's purpose is to put the reader in the right frame of mind to understand the code change.
The reason for the short initial summary line is to support commands,
such as git show-branch, that list changes by showing just the first
line of each one's commit message.
Please use spaces, never tabs. The file .editorconfig encodes these formatting conventions in a way that most text editors can read.
The corporate is published under the Apache License, Version 2.0. It is important that the codebase continue to be publishable under that license. To make that possible, here are some guidelines on including 3rd party content.
If you submit content that you wrote or that you have authority to submit from your employer or institution, you give it to us under the Apache License, Version 2.0. If the material you submit is already licensed under a similarly permissive license (BSD, ISC), you can tell us that and give it to us under that license instead.
Please make the license of the contribution clear in your pull request. Tell us who wrote it, if that isn't just you. If the code was written for an employer, tell us that too. Tell us what license applies to the code, especially if it differs from the project's Apache License, Version 2.0.
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
(b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as Indicated in the file; or
(c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
(d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
People running for a position should commit an application (found at applications/elections/general_candidate.md) to the records/elections/candidates/[date]/[lastname]_[firstname].md
As described in operating.md, the Issue must be opened 24 hours before the election is held.
- Create an issue and fill out the form
- Add a title in the form [PROJECT NAME] Project Application
- Label it a project application using the Labels tag on the right side
- Submit!
- Create an issue and fill out the form
- Add a title in the form [YOUR NAME] Corporate Overlord Application
- Label it a corporate overlord application using the Labels tag on the right side
- Submit! (and Profit?)
- Create an issue and fill out the form
- Add a title in the form [YOUR NAME] Elected Position Application
- Label it a elected position using the Labels tag on the right side
- Submit!
I don't know - I'm not your secretary. Check the slack or BIFFUD Calendar. It may or may not be right.
Create a new file in poems. Wait for mockery or praise or most likely no response.
Hire a lawyer? Or:
- Create an issue and fill out the form
- Add a title in the form [Company or Person NAME] Contract Application
- Label it a contract using the Labels tag on the right side
- Submit! And send it to them for their review, probably
It should be in the master agenda but it probably isn't (yet). Check order agenda
There will probably be a template for this at some point but for now I recommend whining loudly in the #biffud-corporate slack
It should be in the master minutes but it probably isn't (yet). Check order minutes
- Create an issue and input the basic information, including the project, request reason, cost, etc
- Add a title in the form [Project] Expense Request
- Label it a expense request using the Labels tag on the right side
- Submit!
Use the Tome of Knowledge: Overmind
Use the Tome of Knowledge: Keeper of Lore
Use the Tome of Knowledge: Beastmaster