search

pkulchenko / ZeroBraneStudio

Lightweight Lua-based IDE for Lua with code completion, syntax highlighting, live coding, remote debugger, and code analyzer; supports Lua 5.1, 5.2, 5.3, 5.4, LuaJIT and other Lua interpreters on Windows, macOS, and Linux
http://studio.zerobrane.com/
Other
2.61k stars 519 forks source link

How to update API file for corona SDK #1073

Closed b-and-p closed 4 years ago

b-and-p commented 4 years ago

Hi, I would like to submit an updated API for corona SDK. Do I need to fork the project first? Sorry, first time attempting to collaborate on GitHub.

pkulchenko commented 4 years ago

@b-and-p, yes, you'd need to fork the project and create a pull request with your changes.

Before you do that though, where are you getting the updated SDK documentation from? api/lua/corona.lua file already includes the script that processes CoronaSDK-APIDOC file and generates the api structure recognizes by the IDE. Is that the process you are using?

b-and-p commented 4 years ago

Yes, I ran your script on current API markdown docs.

pkulchenko commented 4 years ago

Cool; you can submit the pull request if you want and I'll merge the changes. Github has instructions here: https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request. Just make sure you create a separate branch to make a pull request from. What's the source of the corona docs?

b-and-p commented 4 years ago

I got the docs here: https://github.com/coronalabs/corona-docs

pkulchenko commented 4 years ago

@b-and-p, merged #1074; thanks!