Skip to content

Contribute

Tawa Nicolas edited this page Jan 22, 2023 · 4 revisions

How to contribute to Phoenix?

Before reporting issues, requesting features, or submitting any other contribution, kindly search through the already submitted ones to avoid duplicates.

It is also worth going over the Project State to get an understanding of the direction in which the project is going.

Reporting Issues

Please use the Issues page under this repository to report bugs.

Feature Requests

Please use the Discussions page under this repository to submit ideas and feature requests, as well as general discussion topics that you'd like to get other developers' opinions on.

Code Contributions

Getting Familiar with the Project Architecture

It is recommended that you get familiar with the Project Architecture before diving into the code.

Forking and Opening a Pull Request.

Please include as much relevant information as possible in your PR description. At this point, there is no template for the PR description, and this will rely on your best judgment.

Don't forget to include all the relevant pages from the Discussions page and/or the link to the Issue created.

Xcode Cloud is used as a CI/CD solution for Phoenix. When a new PR is opened or a new commit is pushed to the PR, a workflow will run for the Unit Tests and another one for the UI Tests.