The following information is incredibly helpful when raising issues:
Thanks for wanting to contribute to Caliburn.Micro. Contributions don’t need to take the form of code, submitting issues and writing documentation is just as important.
You can clone this repository locally from GitHub using the “Clone in Desktop” button from the main project site, or run this command in the Git Shell:
If you want to make contributions to the project, forking the project is the easiest way to do this. You can then clone down your fork instead:
git clone firstname.lastname@example.org:MY-USERNAME-HERE/Caliburn.Micro.git Caliburn.Micro
Documentation of building the code is currently available on the Caliburn.Micro website.
The Caliburn.Micro is broken up into three groups of assemblies.
EventAggregator. It’s a Portable Class Library designed to work on as many platforms as possible. However due to some limitations we create the Core assembly for Silverlight 5 and .NET 4.0 separately although they share code using linked files and compilation symbols.
When you’re ready to make a change,
create a branch
master branch. We use
master as the default branch for the
repository, and it holds the most recent contributions, so any changes you make
in master might cause conflicts down the track.
If you make focused commits (instead of one monolithic commit) and have descriptive commit messages, this will help speed up the review process.
You can publish your branch from GitHub for Windows, or run this command from the Git Shell:
git push origin MY-BRANCH-NAME
Once your changes are ready to be reviewed, publish the branch to GitHub and open a pull request against it.
A few little tips with pull requests:
[WIP]to indicate this is a work-in-progress. It’s always good to get feedback early, so don’t be afraid to open the PR before it’s “done”.
Don’t forget to mention in the pull request description which issue/issues are being addressed.
Some things that will increase the chance that your pull request is accepted.