Skip to content
This repository was archived by the owner on May 15, 2024. It is now read-only.

Latest commit

 

History

History
32 lines (20 loc) · 1.87 KB

File metadata and controls

32 lines (20 loc) · 1.87 KB

Contributing

Hello and thank you for your interest in the Photon project!

Photon follows the classic fork & pull model: when you want to modify something, you fork the official repository, develop your feature or bugfix, and submit a Pull Request.

This file is here to answer your questions about the contribution to the project.

What can I help you with?

Look at the current issues to see what the pending/ongoing tasks are. You can help with:

  • The code itself: develop new features or fix bugs, in Java or Scala (decent skills required).
  • The code's documentation: explain what the code does.
  • The project's wiki: explain how the different parts of Photon works, like plugins, commands, etc.
  • Something else: You think about something else that can benefit the project? You're welcome to discuss it on the discord server!

What should I do before contributing?

  1. Setup the project.
  2. If you code, read the mandatory coding style and configure your IDE to respect it.
  3. Read the wiki to learn more about the project's internals.
  4. Join the discord server. It's not an obligation but a strong suggestion, because it's very practical to discuss about the project (or other things ^^).

I've found a bug, how do I report it?

  1. Check that this bug hasn't been reported already.
  2. Report it by creating a new issue.

I have a question!

Ask it on the discord server (yeah, I insist on the discord ^^) and I'll be happy to answer.