Skip to content
This repository has been archived by the owner on Jun 1, 2024. It is now read-only.

Latest commit

 

History

History
54 lines (36 loc) · 1.73 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.73 KB
Raw

Contributing to Funland

The Funland project welcomes contributions from anybody wishing to participate. All code or documentation that is provided must be licensed with the same license that Funland is licensed with (MIT, see LICENSE.txt).

General Workflow

  1. Make sure you can license your work under MIT

  2. Before starting to work, make sure there is a ticket in the issue or create one first. It can help accelerate the acceptance process if the change is agreed upon

  3. If you don't have write access to the repository, you should do your work in a local branch of your own fork and then submit a pull request. If you do have write access to the repository, never work directly on master.

  4. When the work is completed, submit a Pull Request.

  5. Anyone can comment on a pull request and you are expected to answer questions or to incorporate feedback.

  6. It is not allowed to force push to the branch on which the pull request is based.

General Guidelines

  1. It is recommended that the work is accompanied by unit tests.

  2. The commit messages should be clear and short one lines, if more details are needed, specify a body.

  3. New source files should be accompanied by the copyright header.

  4. Follow the structure of the code in this repository and the indentation rules used.

  5. Your first commit request should be accompanied with a change to the AUTHORS file, adding yourself to the authors list.

License

All code must be licensed under the MIT license and all files must include the following copyright header:

Copyright (c) $today.year by The Funland Project Developers.
Some rights reserved.

Licensed under the MIT License.
See LICENSE file in the project root for full license information.