Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

51 lines (38 loc) · 1.82 KB
Raw

Contributing Guidelines

You are welcome to contribute to OverrunGL.

Code of Conduct

You must respect the Code of Conduct.

Issues

Issues are only for discussing bugs and proposing new features. For other discussions such as usages, use discussions.

To start with issues, you are recommended to use the issue template.

Pull Requests

The pull request will be reviewed in undetermined time, usually in active iterations which is specified in the Security Policy. Please note that the code must be formatted.

Formatted Code

The formatted code:

  • The header of Java files MUST contain a copy of LICENSE. 
    /*
 * MIT License
 *
 * Copyright (c) <YEAR> 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; this restriction can be widened for non-public APIs;
  • Other rules specified in .editorconfig.

Discussions

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