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.

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 initial PR for Contributing & Coding Standard #920

Draft
wants to merge 27 commits into
base: main
Choose a base branch
from

Conversation

MickLesk
Copy link
Member

@MickLesk MickLesk commented Dec 19, 2024

✍️ Description

  • remove old contributing.md

  • add new contributing.md

  • First Draft, added some functionality and descriptions later

  • Every @community-scripts/contributor are welcome to improve this PR


🛠️ Type of Change

Please check the relevant options:

  • Bug fix (non-breaking change that resolves an issue)
  • New feature (non-breaking change that adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change unexpectedly)
  • New script (a fully functional and thoroughly tested script or set of scripts)

✅ Prerequisites

The following steps must be completed for the pull request to be considered:

  • Self-review performed (I have reviewed my code to ensure it follows established patterns and conventions.)
  • Testing performed (I have thoroughly tested my changes and verified expected functionality.)
  • Documentation updated (I have updated any relevant documentation)

📋 Additional Information (optional)

Provide any extra context or screenshots about the feature or fix here.

@MickLesk MickLesk added documentation A change to documentation investigation We are looking into it guide Guides on how to perform a specific task or configuration labels Dec 19, 2024
@MickLesk MickLesk requested a review from a team as a code owner December 19, 2024 09:53
@github-actions github-actions bot added the maintenance Code maintenance or general upkeep of the project label Dec 19, 2024
@MickLesk MickLesk marked this pull request as draft December 19, 2024 10:10
"type": "ct",
"updateable": true,
"privileged": false,
"interface_port": DEFAULT-PORT,
Copy link
Contributor

Choose a reason for hiding this comment

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

maybe use something representative for this example, either 80 or 8080

Choose a reason for hiding this comment

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

Can do.
But you can also change in the branch as you like.

@remz1337
Copy link
Contributor

Great stuff overall. Sorry I pushed a commit directly fixing typos (I thought it would create a review). I'm ok with this but I suggest going over it again, there seems to be a lot of typos. Not sure why some stuff are capitalized either (Coding standards, Application...). And why the AppName.md? Is that something new with the big update you did? Never seen that before.

@michelroegl-brunner
Copy link
Member

Great stuff overall. Sorry I pushed a commit directly fixing typos (I thought it would create a review). I'm ok with this but I suggest going over it again, there seems to be a lot of typos. Not sure why some stuff are capitalized either (Coding standards, Application...). And why the AppName.md? Is that something new with the big update you did? Never seen that before.

Thank you. And no worries about the push, you can and should edit as you see fit.
Sorry about the typos i'm no englisch native speaker. But i ask a colleagu of mine, a english teacher, if they a willing to habe a look and fix the things i got wrogn. And regarding the capitalization, in german we basicly capitalize every other word, so its force of habbit^^. I created the AppName.sh and AppName-install.md with the help of Mick. I think this is a good
way to explain to new scripters how they should tackle different problems when creating new scripts. IMHO with this format, (splitting them up this way) it is way less confusing what each script dose and why there is the need for two of them in the first place. If you, someone else feel like this is to much or convoluted, feel free to comment ore change as you like.
But i think something like this is the way to go to make the life easier for everey new contributor as well us as maintainers, so we can link to some fixed references instead of a random
script we pick out of the codebase. And i do not want to force "my" standards on anyone, i basicly picked them with the help of @MickLesk how did most of this work anyway in the first place. I just organized it in another way :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation A change to documentation guide Guides on how to perform a specific task or configuration investigation We are looking into it maintenance Code maintenance or general upkeep of the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants