search

adopted-ember-addons / program-guidelines

Checklist and guidelines for the Adopted Ember Addons org.
MIT License
3 stars 5 forks source link

idea + discussion: standardization proposals #3

Closed ghost closed 4 years ago

ghost commented 5 years ago

I've had these and a couple more ideas in the past few months. Each task isn't necessary required or worded best but I think it could be helpful to try adding more recommendations to streamline contribution and maintenance. What are your thoughts on advocating standardization? As a less active maintainer I would like the equivalent of ember conventions for adopted addons.

Rendered

mcfiredrill commented 4 years ago

How about requiring the Contributor Code of Conduct? It seems to be adopted by many addons already. https://github.com/adopted-ember-addons/ember-file-upload/blob/master/CONDUCT.md https://github.com/adopted-ember-addons/ember-sortable/blob/master/CODE_OF_CONDUCT.md

Ember itself has a separate guidelines page. https://emberjs.com/guidelines/

ghost commented 4 years ago

@mcfiredrill I think that is a great idea. Could you open that in a separate PR? I'll try to get this rebased and reviewed so we have a section for this kind of guideline.

jelhan commented 4 years ago

I think this is a great starting point. I think it should be even way more opinionated. Working on an adopted add-on the maintenance criteria where often unclear to me. In both roles. Either if providing a pull request myself or reviewing another one. E.g. what ember versions to support and when it's okay to drop support for one? What test coverage are we aiming for? What is the priority of docs? Should I reject a pull request implementing a feature if the code is fine but it's missing any documentation and tests?

Having recommendations for these questions would help me to keep focus, avoid bikeshedding and get confidence that my contribution is helpful for the community.

knownasilya commented 4 years ago

Agree with @jelhan's feedback.

ghost commented 4 years ago

Sounds great @MelSumner! Thank you for reviewing. @jelhan @knownasilya great points! I feel like we'll need to establish a policy. Differentiate between:

I propose we establish key questions and try to state our problem clearly and then we can determine the best way to comprehensively address those concerns. As an auxiliary ember community project we have a great opportunity to define the problem well and I think all these suggestions will pay dividends in the community.

perhaps we create a design document, in notion maybe?

ghost commented 4 years ago

/cc @MelSumner