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

Add contributor guidelines file and start discussion around dao-kit contribution #20

Merged
merged 1 commit into from Aug 9, 2018

Conversation

Projects
None yet
3 participants
@benstew
Copy link
Contributor

benstew commented Aug 8, 2018

Meets requirements for #12 with boilerplate contribution file.

Also, I wanted to spark up a discussion around contribution to the dao-kits monorepo based on my initial experience. I know there are a lot of advancements slated for this repo (eg TCR, Payroll, and the BareKit) but I had two primary pain points as an external contributor that I wanted to mention.

The good news is that I'm interested in lending a hand to solve those issues for future contributors :)

Pain Point 1: Limited documentation
There is great power in kits and templates but I found it challenging to understand the future direction which makes thinking through documentation (like contribution guidelines) a little challenging. With upcoming improvements, specifically BareKit, I would love to understand how we envision the evolution of kits.

Honestly, I think this could be as easy as updated the README and maybe a short blog post or wiki entry. I think this would allow potential contributors to really conceptualize the power, flexibility, and importance of kits/templates in the system.

Pain Point 2: Kit code security & audit processes
Modification to kit code will be scrutinized (potentially more than other areas) and would love to learn more about the form this will take in the near term. It's mentioned that once available, all mainnet-ready kits will leverage a security.md file that essentially flags potential issues/concerns that deviate from a best practice approach. I see the value in adding a lightweight version of that for all kits. Would be great to also get some form minimal integration test (even now, if not done already)

To sum up, I'm interested in learning more about the future development of dao-kits and determining what quick, high value add improvements could be done to make this repo more friendly to outside contributors.

@CLAassistant

This comment has been minimized.

Copy link

CLAassistant commented Aug 8, 2018

CLA assistant check
All committers have signed the CLA.

@benstew benstew referenced this pull request Aug 8, 2018

Open

Add CONTRIBUTING file #12

@@ -0,0 +1,15 @@
# Contributing to Aragon DAO Kits and Templates

This comment has been minimized.

@benstew

benstew Aug 8, 2018

Contributor

Boilerplate language that I'm happy to update based on the discussion. Wanted to get a better picture of the future before trying to change too much.

This comment has been minimized.

@izqui

izqui Aug 9, 2018

Member

I think this looks good

@luisivan luisivan requested a review from izqui Aug 9, 2018

@izqui

izqui approved these changes Aug 9, 2018

Copy link
Member

izqui left a comment

Looking good @benstew, thanks for the contribution and offering to help out!

The pain points you mention are definitely areas that need work.

For the first one, the plan for DAO kits is to build initial configurations for different types of DAOs that can later be further configured using the app to change permissions or install additional apps. Adding some more info on this in the README would be super useful.

For the second one, totally agree on the scrutiny required for modifying DAO kits, specially the ones that will be used on mainnet. For the initial mainnet kits (multisig and democracy under beta), there are some integration tests already.

@@ -0,0 +1,15 @@
# Contributing to Aragon DAO Kits and Templates

This comment has been minimized.

@izqui

izqui Aug 9, 2018

Member

I think this looks good

@izqui izqui merged commit 1530039 into aragon:master Aug 9, 2018

1 check passed

license/cla Contributor License Agreement is signed.
Details
@benstew

This comment has been minimized.

Copy link
Contributor

benstew commented Aug 9, 2018

Thanks for the review @izqui.

I can open up a new issue for updating the README since I won't get to that this week. And great to know about the integration tests. Now I can sleep at night ;)

Also, I will probably focus on the TCR work that the team has been focused. I have a keen interest in TCRs and I think that's where I will look to add value next.

@izqui

This comment has been minimized.

Copy link
Member

izqui commented Aug 9, 2018

Awesome, thanks to you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment