search

tatsoku / hamon

A WIP homemade shell in C, focusing on customizability, performance and support.
BSD 3-Clause "New" or "Revised" License
3 stars 3 forks source link

CONTRIBUTING.md #40

Open Bytenol opened 2 months ago

Bytenol commented 2 months ago

The current procedure listed on "How to contribute" produced little or no context regarding same. More context would be needed on atleast each of the directories, why "clang" should be the only compiler, preferred coding practices, github branch creation for new changes etc.

h4rldev commented 2 months ago

Hi, and thanks for the issue!

I'll make sure to implement more info on how to contribue. I've more recently opened my horizon to allow gcc to be used as a compiler, just change the CC variable in the build script to use gcc instead.

There's no set coding practice that I'd note to align to, or atleast not anything that can't be found outside the repo's source code itself.

GitHub branches are quite simple, main is protected and can only be merged to with reviews & workflows passing, I'm gonna make sure that the ci.yml actually work properly due to the build script never really returning 1, just continuing even if something doesn't compiles or links.

Edit: I'll highlight all of this in a CONTRIBUTING.md file that will be in the root of the repo, at a later date.

Bytenol commented 2 months ago

Oh when the contributing.md is ready, hope i get notified

h4rldev commented 2 months ago

I'll be sure to notify once it's merged into main!