Skip to content

Latest commit

 

History

History
76 lines (51 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

76 lines (51 loc) · 2.65 KB
Raw

Contributing to Solutions Builder

This doc explains the development workflow to get started contributing to Solutions Builder.

If you are looking for the general development guide for the generated code from this template, please refer to docs/DEVELOPMENT.md

Bug Reports

If you encounter any issues or bugs, please file a new GitHub Issue.

  • The Google team will triage the issues and will reply to your issues shortly.

Development

Tool requirements:

Install the dependencies according to root README.md.

Here's the high-level steps of the development flow:

  • Create a new fork and a new feature branch.
  • Develop and test locally (with your own Google Cloud project)
  • Create a Pull Request to merge to main branch.

Create a new Fork

  • Click this link to create a new fork.
  • Check out the code from your fork. 
    git clone https://github.com/<your-Github-handle>/solutions-builder.git
  • Make sure the origin points to your fork. 
    $ git remote -v
origin  https://github.com/<your-Github-handle>/solutions-builder.git (fetch)
origin  https://github.com/<your-Github-handle>/solutions-builder.git (push)
  • Check out a new branch. This is to make your local work clean and separated. 
    git checkout -b new-feature

Preparation

Install solutions-builder as local package.

cd solutions-builder
poetry install

At this moment, you shall see the solutions-builder is installed with local package.

pip freeze | grep solutions-builder
-e git+ssh://[email protected]/GoogleCloudPlatform/solutions-builder.git@[HASH]#egg=solutions_builder

Test code changes in the Template

Once you made a few code changes locally, you'd want to test with a real Google Cloud project to ensure all steps run correctly.

We will add more details of how to run end-to-end testing with your own test project.

Commit code changes

Once generated {{cookiecutter.project_id}} folder, run the following to commit the changes to your fork.

git commit -a -m 'your message about this change'.

Create a Pull Request for review

Create a Pull Request to merge to main branch, and tag the project owners/admins to review.

  • The project owners and admins will run end-to-end tests (TBD) to ensure the change doesn't break existing functions.