Giter Site home page Giter Site logo

Comments (9)

PenguinCabinet avatar PenguinCabinet commented on August 11, 2024 1

Thank you for replying and telling me.
I understood those.
When I finish those changes,I am going to mention to you and open a PR.

from awesome-ebitengine.

PenguinCabinet avatar PenguinCabinet commented on August 11, 2024 1

Thank yooooooooooou for that you teach to me politely!!!!!
I could add it to the list by your help!!

from awesome-ebitengine.

sedyh avatar sedyh commented on August 11, 2024

Hello, thanks for the suggestion.

Could you please make the following changes:

  • Change all names (repo/types/functions/etc) according to the naming convention and generally accepted standards in golang.
  • Arrange comments on types/functions, and make documentation on pkg.go.dev.
  • Add tags to get package by version number.
  • Make a tutorial and quick start in English and add a couple of examples using this library.
  • Add unit tests, if possible.
  • Make a fork and issue an offer as a PR.

https://go.dev/doc/effective_go#names
https://go.dev/doc/effective_go#commentary
https://pkg.go.dev/about#adding-a-package
https://github.com/golang-standards/project-layout

from awesome-ebitengine.

PenguinCabinet avatar PenguinCabinet commented on August 11, 2024

Hi.

Summary

  • Change all names (repo/types/functions/etc) according to the naming convention and generally accepted standards in golang.
    • https://github.com/PenguinCabinet/pgfsm
    • I changed the repo to the name that is one word and use only lower case letters for standards in golang.
    • I changed names of types and functions to the ones of Camel Case for standards in golang.
  • Arrange comments on types/functions, and make documentation on pkg.go.dev.
    Add tags to get package by version number.
    • Please watch here.
  • Add tags to get package by version number.
  • Make a tutorial and quick start in English and add a couple of examples using this library.
  • Add unit tests, if possible.
  • Make a fork and issue an offer as a PR.

from awesome-ebitengine.

sedyh avatar sedyh commented on August 11, 2024

Hi, sorry for the long wait.

  • There are still snake case variables in QuickStart and /test/main.go.
  • Could you add a very small separate project that would use this lib to the /examples folder?
  • I'm wondering why use new() instead of separate constructors? Just so as not to initialize the internal structures ahead of time?

There are also small nuances with indents and spaces, gofmt and goimports will quickly solve them automatically.
Also I think a good linter can very quickly suggest what can be done (like golangci-lint).

from awesome-ebitengine.

PenguinCabinet avatar PenguinCabinet commented on August 11, 2024

Hi,thank you for your reviewing.

  • There are still snake case variables in QuickStart and /test/main.go.
    • I finished changing all snake case variables into the ones of Camel Case in README.md, README_en.md and Tutorial_en.md.
      • I'm going to fix Tutorial.md.
  • Could you add a very small separate project that would use this lib to the /examples folder?
  • I'm wondering why use new() instead of separate constructors? Just so as not to initialize the internal structures ahead of time?
    • Hmm...There is no particular meaning.Should I use separate constructors instead of new()?
  • I set to run golangci-lint on Github Action.

from awesome-ebitengine.

sedyh avatar sedyh commented on August 11, 2024

Hello. Sorry to bother you, could you also fix the snake case in the readme and run it through gofmt as well?

Regarding individual constructors, in the examples, immediately after initialization, fields are set (screen sizes and the first scene). I think it’s still worth taking them out separately, it’s better to let the package deal with initialization itself, it will be easier to maintain later.
https://web3.coach/golang-why-you-should-use-constructors

Everything else is ok, I'm ready to merge after the fix.

from awesome-ebitengine.

PenguinCabinet avatar PenguinCabinet commented on August 11, 2024

Hi,No problem.Thank you for your teaching.

  • I finished changing all snake case variables to the ones of camel case.snake case variables is extinct in my library.
  • I used separate constructors instead of new().
  • I run it through gofmt but nothing changed.I think the Go extension of VS code applies automatically gofmt to source codes.

from awesome-ebitengine.

sedyh avatar sedyh commented on August 11, 2024

Okay, the repository has been added to the list.

from awesome-ebitengine.

Related Issues (15)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.