search

djhackersdev / segatools

Loaders and hardware emulators for SEGA games that run on the Nu and ALLS platforms
The Unlicense
51 stars 6 forks source link

Update docs, add CONTRIBUTING, split development docs, templates - [merged] #56

Closed icex2 closed 1 year ago

icex2 commented 3 years ago

Merges doc-update -> master

A few things that should improve overall documentation and clarify a few things like:

icex2 commented 3 years ago

In GitLab by @BemaniWitch on Jun 20, 2021, 17:48

Commented on doc/development.md line 9

Tiny spelling mistake here, gaols should be goals.

icex2 commented 3 years ago

FYI you can use suggestions to propose the change and make it a no-brainer to apply. Also, small stuff like that doesn't require any additional explanations.

developers to identify valuable contributions for this project. As the project evolves, these goals might do as well.
icex2 commented 3 years ago

resolved all threads

icex2 commented 3 years ago

changed this line in version 2 of the diff

icex2 commented 3 years ago

added 1 commit

Compare with previous version

icex2 commented 2 years ago

In GitLab by @Felix on Aug 12, 2021, 23:47

Any thoughts on adding instructions for building on Windows with MSVC? Building under MSVC is relatively easy but does require Meson to be installed separately and the user must enter the appropriate development environment so Meson picks up the correct compiler architecture.

icex2 commented 2 years ago

Makes sense, but would be better if someone else, who went through the process of setting things up on Windows with MSVC already, can add that. I have never done that and would have to spend additional time figuring it out.

Since this MR has been open for over a month and my initial goal is completed, I would suggest further to "forward fix" any further improvements.

icex2 commented 2 years ago

added 52 commits

Compare with previous version

icex2 commented 2 years ago

In GitLab by @tau on Aug 14, 2021, 24:03

I think a 100-line bug report template might be a little bit optimistic. I'd suggest something like the following:

Everything else will in all likelihood need to be filled out by whichever developer does bug triage (e.g. if the issue cannot be reproduced then additional details for a repro case can be requested and the ticket can be closed after a week or two if there is no response).

For merge requests yeah we can be a bit more discerning in our requirements. It would be nice to have something like bemanitools' clang-format enforcement as well, but that sort of CI scaffolding is a big topic and can probably be included in a different MR.

icex2 commented 2 years ago

In GitLab by @tau on Aug 14, 2021, 24:06

MR templates look good to me

icex2 commented 2 years ago

added 1 commit

Compare with previous version