Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: prepare README for public view #351

Merged
merged 1 commit into from
Apr 18, 2022
Merged

docs: prepare README for public view #351

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 🚧 THIS PROJECT IS IN ALPHA STAGE 🏗️
Copy link
Contributor

@ace-n ace-n Apr 15, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth being a bit clearer about what this means, or am I being pedantic? 🙂

e.g. add this note:

🚨 This project is in Active Development and is a work in progress. Code may be broken, tests may fail, and rapid and/or breaking changes may occur with little or no warning. 🚨

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's good enough as is :)


# Emblem Giving: A Sample Application

> This sample application is only for learning purposes.
Expand All @@ -10,8 +12,7 @@ Real financial transactions are not made, and the giving campaigns in the app ma

## Project Status

* **Release Stage:** Internal Preview (pre-MVP)
* **Work Pattern:** Active development, 2 week sprints
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why are we removing the "Active development, 2 week sprints comment?

* **Release Stage:** Alpha
* **Self-service / Independent Setup:** Follow the instructions to set up Emblem by reading the [setup quickstart](./docs/tutorials/setup-quickstart.md), or by launching the [Interactive Walkthrough](https://ssh.cloud.google.com/cloudshell/editor?cloudshell_git_repo=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Femblem&cloudshell_tutorial=docs%2Ftutorials%2Fsetup-walkthrough.md) on Cloud Shell.

## Learn About This Project
Expand All @@ -24,8 +25,6 @@ Real financial transactions are not made, and the giving campaigns in the app ma
* Become a [CONTRIBUTOR](./CONTRIBUTING.md)!
* Check out our shovel-ready [Good First Issues](https://github.com/GoogleCloudPlatform/emblem/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22good+first+issue%22) or go a bit deeper in [Help Wanted](https://github.com/GoogleCloudPlatform/emblem/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A%22help+wanted%22)

Googlers-only: Learn more about this project from the [pitch deck](https://docs.google.com/presentation/d/13F8Ns-mR6WG12C2ulI4dCIqjSUJgextiNxZA0I6wagw/edit)

---

This is not an official Google project.