Skip to content

Latest commit

 

History

History
46 lines (27 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

46 lines (27 loc) · 3.87 KB

Lina Engine contributing guide

Thank you for investing your time in contributing to Lina Engine.

Read the Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:

Getting started

Please note that we support any kind of contribution to the C++ codebase regarding bug fixes, utility support, improvements and new features. Contributions regarding design/structure/architecture changes of the Codebase, as well as the bureaucracy of the Lina Project such as organization changes, CMake files, readme, contributing, PR/issue templates, along with git files should only be requested after a confirmation on the Discussions section (except small fixes on the latter regarding broken links, typo fixes and so on).

Issues

Create a new issue

If you spot a problem with the docs, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.

Solve an issue

Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.

Make changes in a codespace

More information regarding making changes on the codespace, coding guideliness and alike will be provided soon. So far, we ask contributors to obey the coding guideliness & structures in the repo as much as they can :).

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

  • Fill the "Ready for review" template so that your PR could be reviewed. This template helps reviewers understand your changes as well as the purpose of your pull request.
  • Don't forget to link PR to issue if you are solving one.
  • Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
  • We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
  • As you update your PR and apply changes, mark each conversation as resolved.
  • If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.