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

Code style guidelines #35

Open
MuffinTastic opened this issue Jan 27, 2023 · 4 comments
Open

Code style guidelines #35

MuffinTastic opened this issue Jan 27, 2023 · 4 comments
Labels
context/native type/documentation Improvements or additions to documentation type/enhancement New feature or request

Comments

@MuffinTastic
Copy link
Contributor

It's easy enough to follow the implicit style set by the existing C++ code, but we should probably explicitly set some convention guidelines for C++ just as we do for C#.

Also, do we have any guidelines in mind for what kinds of functionality should go approximately where on the managed side after bindings are made? In #34 I'd like to add something that actually calls the Root::Quit() binding, but I'm (as of writing this) honestly not entirely sure where it should go (Common or Engine, etc). It'll probably happen again, so it would be nice to have rough ideas for the future

@xezno xezno added type/documentation Improvements or additions to documentation type/enhancement New feature or request context/native labels Jan 27, 2023
@xezno
Copy link
Member

xezno commented Jan 27, 2023

Agreed, I'm going to start cleaning stuff up and documenting it. I'm probably going to set up something like ReadTheDocs for this since it's battle tested and I find it better than github's wiki system, though I'm open to other suggestions!

@xezno
Copy link
Member

xezno commented Jan 28, 2023

I started some docs over on the mocha-docs repo but I haven't had enough time today to add anything meaningful to them. It currently uses markdown but previewing stuff is a pain in the ass if you don't have ruby installed, so I'm going to look for something that offers a browser editor instead.

@MuffinTastic
Copy link
Contributor Author

Looks good. Imo it's easy enough to use GitHub Codespaces (VSCode in your browser) to edit it, it has ruby and jekyll and bundler and everything else you might want pre-installed, no installation fuss involved. No complaints about something even easier though

@xezno
Copy link
Member

xezno commented Jan 28, 2023

Moved the wiki over to MediaWiki because it's easier to edit, should just be able to make an account on there and edit stuff: https://wiki.gu3.me/index.php/Main_Page. Will swap the domain out for something better at a later date

@xezno xezno added this to the Initial Release milestone Mar 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
context/native type/documentation Improvements or additions to documentation type/enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants