We love contributions. To get started contributing you might need:
- Get started with git
- How to create a pull request
- An issue to work on - We are
on Up for grabs, our up for grabs issues are tagged
up-for-grabs - An understanding of how we write tests
Once you know how to create a pull request and have an issue to work on, just post a comment saying you will work on it. If you end up not being able to complete the task, please post another comment so others can pick it up.
Issues are also welcome, failing tests are even more welcome.
- Try to use feature branches rather than developing on master
- Please include tests covering the change
- The docs are now stored in the repository under the
Docsfolder, please include documentation updates with your PR
Find where your issue would logically sit, i.e. find the class closest to your issue.
We are currently using XUnit, so just create a descriptive test class or extend an existing one.
Also, you might find it useful to make yourself familiar with the excellent FluentAssertions library as well as StaFact, which is used for running tests in the UI Dispatcher Thread.
Even better include the fix, but a failing test is a great start.
Since we are not automatically watching FontAwesome we invite you to add Pull Requests for updates on Font Awesome.
However, updating to newer version
of @fortawesome/fontawesome-free
and @mdi/font is automated via Update-Fonts.ps1, so
$.\Update-Fonts.ps1
Updating node packages...
Updating web fonts...
Updating css...
Generating IconEnum classes...Next, after successfuly running all tests
$.\Build.ps1 TestReview and commit changes (e.g. git diff/commit).