third-stats icon indicating copy to clipboard operation
third-stats copied to clipboard

Published 20 hours ago • verified publisher icon devmount

Extend Contribution Guidelines

Open devmount opened this issue 4 years ago • 1 comments
trafficstars

Is your feature request related to a problem? Please describe. A section about coding style/coding standard is missing in the current contribution guidelines of ThirdStats.

Describe the solution you'd like Add a separate section for the coding style to the CONTRIBUTING.md that is used in ThirdStats.

Describe alternatives you've considered It's possible, to put that information in a separate file too, but I don't think that'll be necessary.

Additional context See discussion on commit https://github.com/devmount/third-stats/commit/9c1d60e1a25c4db98f905587fae951c03a71f8e6.

devmount avatar Jul 05 '21 12:07 devmount

Suggestions:

  • [ ] For anything that can be linted/automated (jslint, clang-format, whatever), add those to notes, and add CI steps or automations for them. Nothing should be manual where it doesn't need to be.
  • [ ] "Design Goals" context / intro / section to contribution guidelines
  • [ ] "make sure there isn't already an existing issue " link directly to issues labelled bugs
  • [ ] " Before creating enhancement suggestions, please check the existing issues a" link directly to issues labelled enhancements
  • [ ] No mention of testing, running tests (do we have tests), adding/requiring tests for bug PR's.

koobs avatar Jun 02 '22 01:06 koobs