mirror of
https://github.com/wailsapp/wails.git
synced 2025-05-02 02:30:48 +08:00
cb6064ff39
* docs: update changelog * feat: update website config * feat(website): add formatting configuration * docs: fix image resource paths and format documents * feat(website): update community guide page Co-authored-by: Lea Anthony <lea.anthony@gmail.com>
35 lines
1.8 KiB
Plaintext
35 lines
1.8 KiB
Plaintext
---
|
|
sidebar_position: 20
|
|
---
|
|
|
|
# Developing New Features
|
|
|
|
We are always keen to add features to Wails and expand on what the project can do.
|
|
The process for adding new features are as follows:
|
|
|
|
- Pick an enhancement ticket with the "TODO" label. It's preferable to select one from the current
|
|
[Backlog](https://github.com/orgs/wailsapp/projects/1/views/1) but the choice is yours.
|
|
- Before developing, check that the ticket includes the following information:
|
|
- The purpose of the enhancement
|
|
- What is out of scope for the enhancement
|
|
- What platforms the enhancement targets (most features should be cross-platform unless there's a very specific reason)
|
|
- If the ticket does not include this information, feel free to request the information from the
|
|
person who opened the ticket. Sometimes placeholder tickets are created and require more details
|
|
- Comment on the ticket stating you wish to develop the feature
|
|
- Clone the repository and create a branch with the format `feature/<ticket_number>_<ticket_title>`
|
|
- New features often require documentation so please ensure you have also added or updated the documentation as part of
|
|
the changes
|
|
- Once the feature is ready for testing, create a draft PR. Please ensure the PR description has the test scenarios and
|
|
test cases listed with checkmarks, so that others can know what still needs to be tested.
|
|
- Once all the testing is completed, please update the status of the PR from draft and leave a message.
|
|
|
|
:::note
|
|
There is nothing stopping you from opening a ticket and working on it yourself, but please be aware that all
|
|
enhancement requests are reviewed for good fit. Not all ideas will be selected so it's best to have discussion
|
|
on the ticket first.
|
|
:::
|
|
|
|
:::warning
|
|
Any PRs opened without a corresponding ticket may be rejected.
|
|
:::
|