Skip to content

Latest commit

 

History

History
244 lines (167 loc) · 8.04 KB

CONTRIBUTING.md

File metadata and controls

244 lines (167 loc) · 8.04 KB
Raw

Contributing to IBeam

We'd love for you to contribute to our source code and to make IBeam even better than it is today! Here are the guidelines we'd like you to follow:

Code of Conduct

As contributors and maintainers of the IBeam project, we pledge to respect everyone who contributes by posting issues, updating documentation, submitting pull requests, providing feedback in comments, and any other activities.

Communication within our community must be constructive and never resort to personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.

We promise to extend courtesy and respect to everyone involved in this project regardless of gender, gender identity, sexual orientation, disability, age, race, ethnicity, religion, or level of experience. We expect anyone contributing to the project to do the same.

If any member of the community violates this code of conduct, the maintainers of IBeam may take action, removing issues, comments, and PRs or blocking accounts as deemed appropriate.

If you are subject to or witness unacceptable behavior, or have any other concerns, please drop us a line at [email protected]

Got a Question or Problem?

If you have questions about how to use IBeam, please direct these to StackOverflow and use the ibeam tag. We are also available on GitHub issues.

If you feel that we're missing an important bit of documentation, feel free to file an issue so we can help. Here's an example to get you started:

What are you trying to do or find out more about?

Where have you looked?

Where did you expect to find this information?

Found an Issue?

If you find a bug in the source code, you can help us by submitting an issue to our GitHub Repository. Even better you can submit a Pull Request with a fix.

See below for some guidelines.

Submission Guidelines

Submitting an Issue

Before you submit your issue search the archive, maybe your question was already answered.

If your issue appears to be a bug, and hasn't been reported, open a new issue. Help us to maximize the effort we can spend fixing issues and adding new features, by not reporting duplicate issues.

Here's a template to get you started:

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Environment**
IBeam version:
Python version:
OS:

**Additional context**
Add any other context about the problem here.

**Suggest a Fix**
If you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit).

Submitting a Pull Request

Before you submit your pull request consider the following guidelines:

  • Search GitHub for an open or closed Pull Request that relates to your submission. You don't want to duplicate effort.

  • Make your changes in a new git branch, based off master branch:

    git checkout -b my-fix-branch master

  • Create your patch, including appropriate test cases.

  • Follow our Coding Rules.

  • Avoid checking in files that shouldn't be tracked (e.g dist, build, .tmp, .idea). We recommend using a global gitignore for this.

  • Commit your changes using a descriptive commit message.

    git commit -a

    Note: the optional commit -a command line option will automatically "add" and "rm" edited files.

  • Push your branch to GitHub:

    git push origin my-fix-branch

  • In GitHub, send a pull request to ibeam:master.

  • If we suggest changes then:

    • Make the required updates.

    • Rebase your branch and force push to your GitHub repository (this will update your Pull Request):

      git rebase master -i
git push origin my-fix-branch -f

That's it! Thank you for your contribution!

After your pull request is merged

After your pull request is merged, you can safely delete your branch and pull the changes from the main (upstream) repository:

  • Delete the remote branch on GitHub either through the GitHub web UI or your local shell as follows:

    git push origin --delete my-fix-branch

  • Check out the master branch:

    git checkout master -f

  • Delete the local branch:

    git branch -D my-fix-branch

  • Update your master with the latest upstream version:

    git pull --ff upstream master

Building a Docker Image

To build a Docker image of IBeam, you first need to ensure the CP Gateway is available in the ./copy_cache/clientportal.gw directory.

Building Single-Platform Images for Development

The following commands can be used to build an IBeam image after navigating to the root directory of the repository. The images produced can be used for development and testing on the building machine's platform (currently IBeam only supports amd64 and arm64):

If using docker build, run:

docker build -t ibeam .

If using docker buildx, run:

docker buildx build -t ibeam --load .

Alternatively, docker compose can be used to build and run a local IBeam instance as follows:

Create a compose.yaml file with the following content:

services:
  ibeam:
    build: .
    container_name: ibeam
    env_file:
      - env.list
    ports:
      - 5000:5000
    network_mode: bridge # Required due to clientportal.gw IP whitelist
    restart: 'no' # Prevents IBEAM_MAX_FAILED_AUTH from being exceeded

Create an env.list file in the same directory with the following content:

IBEAM_ACCOUNT=your_account123
IBEAM_PASSWORD=your_password123

Run the following command:

docker compose up -d --build

Building and Pushing Multi-Platform Images

Before You Start

The commands below can be used to setup docker buildx for multi-platform IBeam builds supporting amd64 and arm64 machines. These commands only need to be executed once per machine and are not required for subsequent multi-platform builds.

Build docker buildx from source using:

export DOCKER_BUILDKIT=1
docker build --platform=local -o . git://github.com/docker/buildx
mkdir -p ~/.docker/cli-plugins
mv buildx ~/.docker/cli-plugins/docker-buildx

Next, run the following to install qemu-user-static for multi-platform build support:

docker run --rm --privileged multiarch/qemu-user-static --reset -p yes
docker buildx create --name builder --driver docker-container --use
docker buildx inspect --bootstrap

Build

Once development and testing have been completed, the following command can be used to build a multi-platform image for amd64 and arm64, before immediately pushing to an image repository:

docker buildx build --platform linux/amd64,linux/arm64 -t <repo-username>/ibeam:<tag> --push .

Coding Rules

We generally follow the Google Python style guide.

This guide was inspired by the Firebase Web Quickstarts contribution guidelines.