Skip to content
This repository has been archived by the owner on Nov 25, 2021. It is now read-only.

Update README with new instructions and add template #38

Merged
merged 2 commits into from
Aug 23, 2021

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Aug 20, 2021

This updates our README with some more precise instructions about how to use this repository, and includes a template for issues that encourages us to use these best practices.

closes 2i2c-org/team-compass#216

---

<!--
🚨ONLY USE THIS ISSUE FOR TRACKING🚨

Choose a reason for hiding this comment

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

Love the red lights!!

Copy link

@damianavila damianavila left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for writing the template.
I think it captures the core of our discussions about this topic.

@choldgraf
Copy link
Member Author

choldgraf commented Aug 23, 2021

@damianavila thanks for the feedback! One quick question: I was speaking with @yuvipanda today and he suggested that we rename this from external/ to instead be upstream/, in order to make it more specific what this repository is for (since 'external' could mean lots of different external things unrelated to github, while upstream/ more specifically refers to other repositories...we also use upstream in many places throughout this repository already). This sounds reasonable to me.

Do you have any objection to that? If not, then I'll merge this in and rename the repo + update our docs.

Copy link

@damianavila damianavila left a comment

Choose a reason for hiding this comment

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

Do you have any objection to that? If not, then I'll merge this in and rename the repo + update our docs.

Sounds good to me!!

@choldgraf choldgraf merged commit e2e84c9 into master Aug 23, 2021
@choldgraf choldgraf deleted the templates-readme branch August 23, 2021 22:43
@choldgraf
Copy link
Member Author

cool - thanks!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Write up a README for the external/ repo and create an issue template for "tracking issues" there.
2 participants