Skip to content

Add readme and contributing guide#83

Merged
ISSOtm merged 1 commit into
gbdev:mainfrom
Rangi42:new-readme
May 17, 2026
Merged

Add readme and contributing guide#83
ISSOtm merged 1 commit into
gbdev:mainfrom
Rangi42:new-readme

Conversation

@Rangi42
Copy link
Copy Markdown
Contributor

@Rangi42 Rangi42 commented May 17, 2026

This PR fixes #40, partly based on two previous attempts:

Credit to both of those efforts for my even starting this one! Largely by putting pieces of those together, taking the previous review into account.

The CONTRIBUTING.md guide is not comprehensive because I don't personally know how to write step-by-step instructions for every thing someone might want to contribute (e.g. adding a new test case), but I think it's better to start a document and let it grow.

@vulcandth in particular may have corrections for this PR, since his fork got GBDev to even start maintaining it.

@Rangi42 Rangi42 requested review from ISSOtm and vulcandth May 17, 2026 19:44
@Rangi42 Rangi42 added the documentation Improvements or additions to documentation label May 17, 2026
Copy link
Copy Markdown
Member

@ISSOtm ISSOtm left a comment

Choose a reason for hiding this comment

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

Thanks! Looks good to me, maybe not complete but that's okay.

Comment thread README.md Outdated
@Rangi42 Rangi42 requested a review from ISSOtm May 17, 2026 19:59
Copy link
Copy Markdown
Member

@ISSOtm ISSOtm left a comment

Choose a reason for hiding this comment

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

Thanks!

@ISSOtm ISSOtm merged commit 0464f90 into gbdev:main May 17, 2026
1 check passed
@Rangi42 Rangi42 deleted the new-readme branch May 17, 2026 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a basic README

2 participants