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

CONTRIBUTING.md #40

Open
Bytenol opened this issue Sep 14, 2024 · 3 comments
Open

CONTRIBUTING.md #40

Bytenol opened this issue Sep 14, 2024 · 3 comments

Comments

@Bytenol
Copy link

Bytenol commented Sep 14, 2024

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
Copy link
Collaborator

h4rldev commented Sep 14, 2024

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
Copy link
Author

Bytenol commented Sep 14, 2024

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

@h4rldev
Copy link
Collaborator

h4rldev commented Sep 15, 2024

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

@h4rldev h4rldev changed the title Contribution Procedure CONTRIBUTING.md Sep 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants