Skip to content

Latest commit

 

History

History
51 lines (31 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

51 lines (31 loc) · 3.1 KB
Raw

Contributing to GoZen

Thank you for considering contributing to GoZen! Your help is greatly appreciated in fixing bugs, creating new features, improving the editor, and maintaining localization support. This document outlines the guidelines and expectations for contributing to the project. Please take a moment to review the information below before making any contributions.

Project Overview

GoZen is an open-source video editor developed using the Godot game engine. The primary language used is GDScript, with Python and GD extensions (written in C++) also present. The project is licensed under the AGPL-3.0 license.

Getting Started

To contribute to GoZen, make sure you have the following:

How to Contribute

  1. Fork the project on GitHub to create your own copy;
  2. Create a new branch in your forked repository with a descriptive name for the changes you plan to make;
  3. Before submitting your changes, rebase your commits to ensure the branch consists of a maximum of one commit (unless multiple commits are justified);
  4. Open a pull request from your branch to the main repository;
  5. Wait for code review and feedback from the project maintainer (you will be notified through the pull request);
  6. Address any feedback or requested changes and update your pull request;
  7. Once your pull request is approved, it will be merged into the main repository;

Reporting Bugs and Requesting Features

For bug reports and feature requests, please follow the guidelines below:

Bug Reports: Provide a clear and detailed description of the issue, including steps to reproduce it. Feature Requests: Clearly explain the desired feature and its expected benefits.

Translation contribution

If you want to contribute with translation, then refer to translation guide.

Code Reviews and Merging Process

All code reviews and merging will be performed by the project maintainer. In the future we may have multiple people whom have access to code reviews and merging. Once your pull request is submitted, it will go through the following process:

  1. The project maintainer will review your changes, providing feedback and suggestions.
  2. Make any necessary revisions based on the feedback received.
  3. Once your changes meet the project's requirements, they will be merged into the main repository.

Communication

Discussions and questions related to GoZen can be held on the GitHub Discussions tab or the project's Discord server.

Additional Resources

Currently, no specific coding conventions, style guidelines, documentation, tutorials, guidelines for writing tests, or code of conduct are available. These resources will be developed and added over time. However, your contributions are still highly encouraged and appreciated.