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

Create CONTRIBUTION document #350

Open
xezon opened this issue Mar 4, 2025 · 2 comments
Open

Create CONTRIBUTION document #350

xezon opened this issue Mar 4, 2025 · 2 comments
Labels
Documentation Is documentation or complementary resource

Comments

@xezon
Copy link

xezon commented Mar 4, 2025

We need to create a document that outlines CONTRIBUTION rules

Similar to how we have done here:
https://github.com/TheSuperHackers/GeneralsGamePatch/blob/main/CONTRIBUTE.md#how-to-contribute-as-developer

We need in code documentation of same/similar kind. So for example in code put:

// TheSuperHackers @bugfix xezon 04/03/2025 Fix buffer overflow of buf variable

And we also want to prepare the yaml documentation so that we can build change logs later.

We can put the yaml change logs into folders
Generals/Design/Changes/v1
GeneralsMD/Design/Changes/v1

For code there are probably more rules we need. I don't have a good overview of it. Can someone take care of it?

@xezon xezon added the Documentation Is documentation or complementary resource label Mar 4, 2025
@tintinhamans tintinhamans pinned this issue Mar 4, 2025
@ViTeXFTW
Copy link

ViTeXFTW commented Mar 4, 2025

Doesn't this require us to sit down and agree on style-guide, commit-/PR template, as well as other relevant contribution factors?

This need to be with the current EA codebase in mind as (sometimes) even just changing styling can (for some reason) change behavior of the code.
Then when all of this is in place, we can write the CONTRIBUTION.md file and add some automatic styling, etc..

@xezon
Copy link
Author

xezon commented Mar 4, 2025

Yes we need to find consensus and then implement that. That effort is currently in discussion at

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Is documentation or complementary resource
Projects
None yet
Development

No branches or pull requests

2 participants