Skip to content

Latest commit

 

History

History
69 lines (60 loc) · 1.79 KB

CONTRIBUTING.md

File metadata and controls

69 lines (60 loc) · 1.79 KB
Raw

Contribution Guide

Rema is an open source application, open to contributions via pull requests (PRs).

If a PR is not based on an existing issue and involves major changes, it is recommended to first create the issue.

Legal

All code contributed and merged into the repository must fall under the same licence as specified in the licence file.

Development

See the wiki for instructions on setup and development.

Code Style Specification

Purpose Preference
Indentation Tabs

Spaces are allowed for character-spacing after tabs in certain cases.
End of Line Line Feed (LF, UNIX style)

Windows batch scripts (.BAT files) are an exception, where "carriage return, line feed" (CRLF, Windows style) is preferred.
Character set UTF-8
Newline at the End of Files No
JavaScript/TypeScript String Literals Single-quotes

Issues

A good issue must have:

  • A clear title.
  • A comprehensive description.
  • A checklist of changes needed.

Pull Requests

A good pull request must have:

  • A clear title.
  • A comprehensive description.
  • Code-blocks in the description displaying the significant changes.
  • The base branch set to main.
  • Commits only relevant to that PR in particular.
  • The respective issue mentioned, see how to link issues to PRs on GitHub.
  • A list of breaking changes and migrations needed, if any.
  • Screenshots.

Made with ❤ by Param.