Anyone is free to help us build and maintain this project. If you see an issue that needs working on because it's important to you, you can contribute to the code by
- First fork the repo, and then clone it locally.
- Create a new branch.
- Review the [README](https://github.com/truenas/webui/blob/master/README.md) file to learn how to build and run the project as well as connect it to your TrueNAS
- Make the required changes.
## Branches
Here's the layout of the main branches
-`master` corresponds to most recent scale
-`truenas/12.0-stable` points to TrueNAS Core 12.0
-`truenas/13.0-stbale` corresponds to TrueNAS Core 13.0
Based on the version of TrueNAS that you would like to make changes to, base your branch from that branch in the project. This affects whether or not we're able to merge your changes back to the relevent version since they have significant differences and cannot be interchanged.
## Code Validation
ESLint is setup to ensure that the code is up to the format standards that we would like to keep in our project. If the linter sees issues in your project, it might ask you to fix those issues before you can make a commit. A set of precommit commands will run to extract new text into translation files and check linter for any issues.
### Translating the UI
If you want to contribute to the translation of our UI, you can do so by editing one of the `[language_name].json` files under `src\assets\i18n\`. In each of those files, text strings and their translations in the relevant language are kept as key/value pairs e.g.,
`
{
...,
"Translate this text": "[Translation]",
...
}
`
## Tests
When adding new changes, try to add unit tests when and where possible. Covering is also reported on the PRs by the `codecov` bot.
## Raise a Pull Request
Pull requests require at least one approved review from one of the members of the UI team before they can be merged. When you create a new PR, a member of the UI team will be automatically asked to review it. Alternatively, you can ask for review from @truenas/ui_team.
Once we have reviewed your PR, we will provide any feedback that needs addressing. If you feel a requested change is wrong, don't be afraid to discuss with us in the comments. Once the feedback is addressed, and the PR is reviewed, we'll ensure the branch is up to date with target, and merge it for you. Depending on the status of the project, sometimes only authorized members of the UI team can merge PRs. In which case, it might take a bit more time for it to be merged.
@@ -108,3 +108,8 @@ You can test your strings in an [online editor](http://format-message.github.io/
Stock images used on the dashboard UI are courtesy of Pixabay.com and are subject to the Simplified Pixabay License.
Full license details can be found at https://pixabay.com/service/license/.
# Contributing
Learn how you can contribute to our project and help us maintain it [on our Contribution guide](https://github.com/truenas/webui/blob/NAS-112459/CONTRIBUTING.md).