Skip to content

Latest commit

 

History

History
30 lines (20 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 2.56 KB
Raw

How to contribute

Thanks for taking the time to read this! You're welcome to contribute to Alakajam, even if you're a beginner who just wants to practice TypeScript. Let's all just be aware that this is an Open Source project, which means we're all here for fun, and running this on our free time.

More than one way to contribute

While this document is oriented towards website development, there are many useful things you can do to help our community:

  • Help with hosting the events, producing artwork for them etc.
  • Assist with event promotion on the web and social media
  • Produce Alakajam-related contents (videos, streams, articles, etc.)

In any case you are welcome to join us on our Discord server.

General tips

  • You are allowed to create an issue for sharing ideas and suggestions or even for just asking questions. Alternately you can also join our Discord.
  • Issues labeled "good first issue" should be the most accessible to new contributors.
  • Please install the eslint Githook mentioned in the Readme to ensure your code looks clean.
  • Interested in following Alakajam! behind the scenes? Join our mailing-list.

What to do if...

  • I found a bug: Please create an issue explaining the problems in details, and in particular how we could reproduce it (with browser info if relevant). In case of a security vulerability, please share your report privately through one of the contacts listed here.
  • I want to develop an existing issue: As long as the issue is not already assigned, work on it right away! You can also post a comment to let us know you're on it. More features ideas are also listed on the wiki to avoid cluttering the issues.
  • I want to develop an idea I have: Share your feature idea through an issue first, so that the maintainers can greenlight it and possibly discuss its implementation.
  • I want to share an idea: Feel free to create an issue or join the Chat to discuss it. Note: we keep track of "wish list" features on a separate document so your issue may be eventually closed.
  • Someone has unacceptable behavior: Please let us know through one of the contacts listed here.

Have fun coding a jam site :)