Come up with a contributing.md file

[sprunk]

Contributors don't know what they're getting into. Let's make our dysfunction transparent. Here's something basic to start:

[sprunk]

Workflow

Before you start

• to report a bug or make a suggestion/request, create a github ticket.
• if you want to contribute code not covered by an existing ticket, make one or at least talk to responsible devs listed below to make sure your work won't get rejected.
• be aware that we're volunteers working in our free time, every interaction may take a while.
• consider getting familiar with the build process, guides and articles relating to your contribution area, and the release schedule.
• if an existing ticket provides a bill of materials it is strongly recommended to follow it.
• keep in mind Recoil is not just for BAR. Don't put overt game design in the engine.

Work in progress

• don't be afraid to ask for feedback/help. This can be on a ticket, your PR, or e.g. on discord.
• if you have pure refactor commits that don't change logic, put them in front if possible. Then they can get merged immediately. The smaller the better.
• there aren't really any tests whatsoever. Come up with some manual tests and let us know what you did. Of course if you write proper tests that's even better.

Finalizing

• feel free to ping maintainers if you think the ball is now in our court. We may take a while to handle your patch otherwise
• a positive review after you're done is not necessarily a sign that the patch is soon to be merged. Reviewing and merging are often done by different people

Responsibilities

• ivand aka lhog - project lead, specializes in rendering
• Tarnished Knight aka lostsquirrel1 - vice lead, specialises in pathfinding and performance
• badosu - gamedev UX (documentation etc.) and UI input
• sprunk - gamedev capabilities (incl. API), general design, reviewing stuff