CONTRIBUTING.md

Contributing Guidelines

You are welcome to contribute to OverrunGL.

Code of Conduct

You must respect the Code of Conduct.

Issues

To start with issues, we recommend you to use the issue template.

Pull Requests

We are not sure when we will review the pull request. Please note that the code must be formatted.

Formatted Code

The formatted code:

• Except auto-generated files, Java files header MUST contain the copy of LICENSE. The copy MUST be ended without an empty line and commented with block style, like this below:

  /*
   * MIT License
   *
   * Copyright (c) 2022-2024 Overrun Organization
   *
   * Permission is hereby granted, free of charge, to any person obtaining a copy
   * of this software and associated documentation files (the "Software"), to deal
   * in the Software without restriction, including without limitation the rights
   * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
   * copies of the Software, and to permit persons to whom the Software is
   * furnished to do so, subject to the following conditions:
   *
   * The above copyright notice and this permission notice shall be included in all
   * copies or substantial portions of the Software.
   */
  

  ;
• The class names MUST be CamelCase;
• The method and field names should be camelCase;
• Other rules specified by .editorconfig.

Discussions

You can visit our forum and create your post, share your experience or just ask some questions.