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.

Sign up for GitHub

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

Jump to bottom

Extend Contribution Guidelines #321

Open
devmount opened this issue Jul 5, 2021 · 1 comment
Open

Extend Contribution Guidelines #321

devmount opened this issue Jul 5, 2021 · 1 comment
Assignees
@devmount
Labels
chore Necessary but less impactful task documentation Improvement or addition to documentation feature Brand new functionality

Comments

@devmount
Copy link
Owner

devmount commented Jul 5, 2021

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 9c1d60e.
@devmount devmount added documentation Improvement or addition to documentation chore Necessary but less impactful task feature Brand new functionality labels Jul 5, 2021
@devmount devmount self-assigned this Jul 5, 2021
@devmount devmount changed the title Extend Contribution Guidlines Extend Contribution Guidelines Jul 5, 2021
@koobs
Copy link
Contributor

koobs commented Jun 2, 2022 •
edited by devmount
Loading

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.

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

@devmount devmount

Labels
chore Necessary but less impactful task documentation Improvement or addition to documentation feature Brand new functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@koobs @devmount