-
Notifications
You must be signed in to change notification settings - Fork 5
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
Add CONTRIBUTING.md #61
Conversation
@macinsight Can you review? Any thoughts/suggestions? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good guidelines on how to contribute.
I'd swap the bit about luacheck mentioning GH Action and manually running, just to mentally drive the point home that it runs on commit/PR-merge, because right now it (at first read) it reads like you're expected to run luacheck yourself.
Current wording:
We use luacheck for linting, just run
luacheck src
in the project root.
Github will automatically run this check on your behalf when submitting a pull request.
Suggested change:
We use luacheck for linting. GitHub automatically runs it as a GitHub Action when you commit or open a Pull Request against the
develop
branch.
If you wish, you can lint your additions yourself before pushing them to the repository by runningluacheck src
in the repository root.
Apart from that, I'm quite happy with it. Concise, welcoming, ticks all the boxes.
re my last, per the docs:
That might just be why. Unintuitive, to say the least. Edit: Naaah, you're repo-owner, not collab. Technically. Eh, nevermind, my meds ain't kicked in yet. |
I'm trying to figure out how the permissions work, it's all very different than what I'm used to (Azure Devops). Once I have it sorted out, you should be able to review and merge PRs for the develop branch. |
Oh god, Azure. I've been 100% Linux for about a decade now, never worked with Azure, hell, haven’t even touched a MS system in the last five years, minus old, crusty Windows 2003 and earlier Servers required for mission-critical traffic light control operations. Those are still working, bare-metal, too! anyway! |
No description provided.