Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 4.21 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 4.21 KB

Contributing to Gyromina

First off, if you're reading this file, I assume you want to help me improve Gyromina. Thanks for doing that, I really appreciate it!

Secondly, please make sure you've read through the code of conduct under docs/CODE_OF_CONDUCT.md before contributing.

General Notes

If you are reporting a bug

  • Check the GitHib issues tab to see if your bug has already been reported
  • If it has not been reported, create a new issue using the primary issue template under .github/ISSUE_TEMPLATE/bug_report.md
  • If you are reporting a security vulnerability, please see the security vulnerability protocol under docs/SECURITY.md

If you are contributing code or patching a bug

  • Open a new GitHub pull request
  • Add a title that summarizes the pull request and list changes in the pull request's description

If you are requesting a feature/improvement

Code Conventions

These are some of the conventions I've tried to follow within Gyromina's code. At the end of the day, though, these are just recommendations, so it's not the end of the world if they're ignored.
That being said, here are the main ones I've followed. You should be able to get the gist of them (along with other minor conventions) once you start reading through some of the existing code:

  • Indent using double spaces (soft tabs)
  • Add function/array definitions for all exported functions/arrays in the 'systemFiles' folder
  • Adding spaces after list items and parameters is preferred ([x, y, z] over [x,y,z])
  • Avoiding spaces inside single line blocks is preferred (if (foo === true) {return bar;} over if (foo === true) { return bar; })
  • Adding some spaces around operators is preferred (i = 5 over i=5, myVar += m * 9 or myVar += m*9 over myVar+=m*9), unless they're wrapped within something (arr[i+2] and myFunc(n*5) are okay)
  • Making things look nice is greatly appreciated! Add whitespace between large segments of code and include brief comments wherever you see fit. Gyromina is an open source project, so keeping things clean and easy to read for future contributors is a must. Comments also help everyone (especially myself) see what certain segments of code do so that we don't end up breaking them later on.

Crediting

If you have contributed or tested code:

  • Feel free to add yourself to the list of contributors or testers in the package file, if you'd like to
    • Contributors: Add your name or a nickname to contributors[] and your GitHub username to contributorGits[], both at the same array index. If you'd like, you can also add your Discord ID (not tag) to contributorIDs[] and a link of your choice to contributorLinks[], both at the same array index as the other two
    • Testers: Add your name or a nickname to testers[]. If you'd like, you can also add your Discord ID (not tag) to testerIDs[] and a link of your choice to testerLinks[], both at the same array index as your username.
  • Feel free to add your name to the list of contributors in the README file as well
    • Contributors: Add your name, nickname, and/or GitHub username under the Repo Contributors heading. Feel free to link any of your names/usernames to personal websites or social profiles. I will add an appropriate contributor marker once your contribution is pushed.
    • Testers: Add your name, nickname, and/or GitHub username under the Helpers heading. Feel free to link any of your names/usernames to personal websites or social profiles, if you'd like. I will add an appropriate tester marker with the next repo push.
  • If you do not add yourself to the package or README files, I will do that before your contributions are pushed (unless you let me know otherwise)