Skip to content

Latest commit

 

History

History
165 lines (108 loc) · 6.72 KB

CONTRIBUTING.md

File metadata and controls

165 lines (108 loc) · 6.72 KB
Raw

Contributing to the Flow Emulator

The following is a set of guidelines for contributing to the Flow Emulator. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table Of Contents

Getting Started

How Can I Contribute?

Styleguides

Additional Notes

Development

Run a development version of emulator server:

make run

Run all unit tests in this repository:

make test

Building

To build the container locally, use make docker-build from the root of this repository.

Images are automatically built and pushed to gcr.io/flow-container-registry/emulator on any push to master, i.e. Pull Request merge

Creating your own deployment

If not using Kubernetes, you can run the Docker container independently. Make sure to run the Docker container with the gRPC port exposed (default is 3569). Metrics are also available on port 8080 on the /metrics endpoint.

To gain persistence for data on the emulator, you will have to provision a volume for the docker container. We've done this through Persistent Volumes on Kubernetes, but a mounted volume would suffice. The mount point can be set with the FLOW_DBPATH environment variable. We suggest a volume of at least 10GB (100GB for a long-term deployment).

Make sure the emulator also has access to the same flow.json file, or always launch it with the same service key, as mentioned above.

docker run -e FLOW_SERVICEPUBLICKEY=<hex-encoded key> -e FLOW_DBPATH="/flowdb" -v "$(pwd)/flowdb":"/flowdb"  -p 3569:3569 gcr.io/flow-container-registry/emulator

How Can I Contribute?

Reporting Bugs

Before Submitting A Bug Report

  • Search existing issues to see if the problem has already been reported. If it has and the issue is still open, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Bug Report?

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible. When listing steps, don't just say what you did, but explain how you did it.
  • Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use Markdown code blocks.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include error messages and stack traces which show the output / crash and clearly demonstrate the problem.

Provide more context by answering these questions:

  • Can you reliably reproduce the issue? If not, provide details about how often the problem happens and under which conditions it normally happens.

Include details about your configuration and environment:

  • What is the version of the emulator you're using?
  • What's the name and version of the Operating System you're using?

Suggesting Enhancements

Before Submitting An Enhancement Suggestion

  • Perform a cursory search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

How Do I Submit A (Good) Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information:

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Explain why this enhancement would be useful to emulator users.

Your First Code Contribution

Unsure where to begin contributing to the Flow Emulator? You can start by looking through these good-first-issue and help-wanted issues:

  • Good first issues: issues which should only require a few lines of code, and a test or two.
  • Help wanted issues: issues which should be a bit more involved than good-first-issue issues.

Both issue lists are sorted by total number of comments. While not perfect, number of comments is a reasonable proxy for impact a given change will have.

Pull Requests

The process described here has several goals:

  • Maintain code quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible UX
  • Enable a sustainable system for the emulator's maintainers to review contributions

Please follow the styleguides to have your contribution considered by the maintainers. Reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Styleguides

Before contributing, make sure to examine the project to get familiar with the patterns and style already being used.

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Go Styleguide

The majority of this project is written Go.

We try to follow the coding guidelines from the Go community.

  • Code should be formatted using gofmt
  • Code should pass the linter: make lint
  • Code should follow the guidelines covered in Effective Go and Go Code Review Comments
  • Code should be commented
  • Code should pass all tests: make test

Additional Notes

Thank you for your interest in contributing to the Flow Emulator!