Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

Latest commit

 

History

History
85 lines (58 loc) · 4.22 KB

CONTRIBUTING.md

File metadata and controls

85 lines (58 loc) · 4.22 KB
Raw

Introduction

Thanks for thinking about contributing to Trains

Following what is said here helps everyone: Pull requests get merged faster, bugs get fixed faster, and issues get answered/fixed faster

What I'm looking for:

  • Documentation: It helps everyone in the long run, especially end-users
  • Bug fixes/reports
  • Fixes to support more users, maybe a new Discord feature, or maybe a different version of ruby
  • Possibly some new features (search for how many instances a specific locomotive appears in photos, as an example)

What I'm NOT looking for

  • I don't want this to turn into a general-purpose Discord bot, it doesn't need to compete with all the bots out there that are
  • Feature requests that would violate the copyright, or property of another person
  • General Support for end-users; That's what the Discord server is for.

Ground Rules

What must be followed:

  • Make sure any pull request actually works and does not break existing code
  • For a major new feature (like the one mentioned in what I'm looking for), create an issue so we can keep track of what gets done when, and have a checklist of what needs to get done.
  • Either have one major feature per version or a few smaller ones (small bug fixes/hotfixes), and no huge differences between versions.
  • Don't be hurtful to new contributors; Instead, be constructive and show them what they did wrong.

Your First Contribution

  • The issues flagged as "good first issue" are ones that usually don't take a lot of effort, and should be easy for anyone to do.
  • If the issue is flagged as "help wanted", we really need people to finish this, and any help would be greatly appreciated.
  • Any issue flagged as "Documentation" is a nice-to-have done whenever and might make some issues have the "good first issue" added to them afterward (snowball effect)

Getting started

How to submit a contribution

For all contributions:

  1. Fork this repo
  2. Do the changes in your fork (please name your commits for what you actually changed, and not just bugfix)
  3. Test the changes, and see if they work well, and the way you want them to
  4. Send a pull request with the right labels, and we'll look at it

How to report a bug

Security Issues

If you find a security vulnerability, please do NOT open an issue. PLEASE email [email protected] instead with the subject line including SECURITY ISSUE:.

  • Later I might set up the GitHub security disclosure system, but for now, just email the address above.

Make sure it's a security issue beforehand though:

  1. Should this not be accessible to the end user
  2. Is this exposing private information (that could be used maliciously)
  3. Can something be disabled without authorization (this should never apply hopefully)

If you answered yes to any of the above, please do what is mentioned above and email [email protected]

Filing a bug report (not a security issue)

When filing an issue, please provide:

  • The version of ruby and the version of the bot you are using
  • The OS version
  • What is off, or not expected
  • Any errors reported in the console (PLEASE put this inside a code block using backticks, you can see how by looking up markdown styling)

How to suggest a feature or enhancement

Ask these questions before sharing a new feature idea

This information will give contributors context before they make suggestions that may not align with the project’s needs.

  • Check the milestones, and see if they apply to any of the current milestones
  • Does this issue take a lot of work? We might not implement it if it takes months to implement
  • Does this violate any copyright laws? (or the DMCA, or any other legal laws)
  • Does this apply to the purpose of the bot (to provide information and photos of trains)
  • See if the issue exists. If it does, show support so we see this is wanted by the community

Code review process

Who reviews pull requests?

-Currently, I (cserver45) need to review the pull request before it gets pushed into the repo.

Community

  • Eventually, I will set up a Discord server dedicated to this bot's development, if it gets popular enough.
  • For now, use the GitHub issues, and general support should be answered by the help question (or the explanations provided by slash commands)