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.

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

docs: prepare README for public view #351

Merged
merged 1 commit into from
Apr 18, 2022
Merged

docs: prepare README for public view #351

merged 1 commit into from
Apr 18, 2022

Conversation

grayside
Copy link
Collaborator

@grayside grayside commented Apr 15, 2022

Part of #350

@grayside grayside requested a review from a team as a code owner April 15, 2022 22:08
@grayside grayside self-assigned this Apr 15, 2022
@grayside grayside changed the title docs: prepare for public view docs: prepare README for public view Apr 15, 2022
@@ -1,3 +1,5 @@
# 🚧 THIS PROJECT IS IN ALPHA STAGE 🏗️
Copy link
Contributor

@ace-n ace-n Apr 15, 2022

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 :)

@@ -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?

@grayside grayside merged commit b9d627b into main Apr 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants