Skip to content

Latest commit

 

History

History
86 lines (54 loc) · 3.74 KB

README.md

File metadata and controls

86 lines (54 loc) · 3.74 KB
Raw

Flashbots Repository Template

standard-readme compliant Discord Contributor Covenant

Template to bootstrap and configure new projects maintained by the Flashbots collective.

Instructions

  • Give a descriptive name to the repository. If it is a generic name like docs, call it flashbots-docs to make it clearer for people who fork it.

  • Every project maintained by the Flashbots collective should have a comprehensive and clear README file that serves as an index.

    • Follow the Standard Readme specification.
    • Read Art of README.
    • The other sections of this file can be used as a template to bootstrap a new repository.

  • Suggested options:

    • Name the default branch main.
    • Enable Issues. Every task related to the project should be written as an issue. If the project is public, the issues should be a welcoming space to get feedback and bug reports from contributors.
    • Enable Preserve this repository.
    • Disable Allow merge commits.
    • Enable Allow squash merging. This makes commits clear and traceable to a pull request.
    • Disable Allow rebase merging.
    • Enable Automatically delete head branches.

  • Suggested access:

    • Add at least two maintainers with the role Admin.
    • Add the flashbots/engineering team with the role Write.

  • Suggested branch protection for main:

    • Enable Require a pull request before merging.
    • Enable Require approvals with 1 approval required.
    • Enable Require status checks to pass before merging.

  • Copy the CODE_OF_CONDUCT file.

  • Fill the contributing instructions in the CONTRIBUTING file.

  • If the project is public, discuss and decide the appropriate license with the team.

Table of Contents

Link to all the following ## headers if the README is longer than 100 lines.

Install

Add the instructions to install the project.

Usage

Add the instructions to use the project. If this section gets long, move to the wiki.

Maintainers

Add the name of at least two maintainers. For critical projects, aim at three.

Projects that have only one maintainer should be demoted from the collective and be moved in github to the personal account of the maintainer.

For these template, the maintainers are:

  • @elopio
  • TODO find a second maintainer

Contributing

Flashbots is a research and development collective working on mitigating the negative externalities of decentralized economies. We contribute with the larger free software community to illuminate the dark forest.

You are welcome here <3.

Security

If you find a security vulnerability on this project or any other initiative related to Flashbots, please let us know sending an email to [email protected].

License

The code in this project is free software under the TODO license name.

Made with ☀️ by the ⚡🤖 collective.