Prepare FCL Contracts Repo for Open Source

[joshuahannan]

Context

We need to prepare the fcl contracts repo for open source.

Definition of Done

Preparation for Open Source

• Repository info

  • Add repo description
  • Update website to flow.com
  • Add relevant repository tags (i.e. blockchain js, etc)

• General security audit

  • Searching for references to internal IP (look into ways to automate search)
  • Remove secrets
  • Remove any mentions of NBA, Moments, USDT, Circle, any other partner names

• Define merge workflow

  • Branch rules:
    • main
      • Require pull request reviews before merging (1 approving review)
        • Require review from Code Owners
      • Require status checks to pass before merging
        • Require branches to be up to date before merging
      • Require linear history
      • Restrict who can push to matching branches
        • Choose onflow/flow team

• Add necessary team members, adjust access levels

  • onflow/flow-admin ⇒ Admin access
  • onflow/flow ⇒ Write access

The following changes should be made in a new branch (i.e. onflow-migration) and merged into main as a PR. Example: onflow/flow#1

• Code cleanup
  • Update Makefile/ package.json with relevant commands (i.e. test start build)
  • Clean up comments
  • Remove unnecessary TODOs
  • THIS IS YOUR CHANCE TO MAKE YOUR CODE PRETTY
• Add CODEOWNERS file
  • Even if repo isn't split into sections for different owners, add at least one owner for the entire repo
• Add contribution guidelines & code of conduct:
  • Contribution guidelines: https://github.com/onflow/cadence/blob/master/CONTRIBUTING.md
  • Code of conduct: https://github.com/onflow/flow-nft/blob/master/CODE_OF_CONDUCT.md
  • Responsible Disclosure Languagehttps://github.com/dapperlabs/flow/pull/14/files
• Add license and copyright notice:
  • License: https://github.com/onflow/flow-nft/blob/master/LICENSE
• Add issue and PR templates:
  • Issue templates:
    • Bug report: https://github.com/onflow/flow-nft/blob/master/.github/ISSUE_TEMPLATE/bug-report.md
    • Feature request: https://github.com/onflow/flow-NFT/blob/master/.github/ISSUE_TEMPLATE/feature-request.md
  • PR template
• Add documentation
  • High level documentation of each contract in the README
  • brief tutorial in the README
  • Comments in the contract and transaction code
• Add tests
  • Convert Go tests to js testing test suite

[alilloig]

https://github.com/onflow/open-source-template just in case it's of any help