ImageSharp.NET Summer Hackfest

James Jackson-South edited this page Aug 20, 2017 · 5 revisions

ImageSharp.NET Summer Hackfest

Welcome to .NET Summer Hackfest with ImageSharp, we'd like to thank you for participating.

ImageSharp is a new, fully featured, fully managed, cross-platform, 2D graphics API designed to allow the processing of images without the use of System.Drawing.

Using a modern, generic API that focuses on making common tasks easy to perform but gives you the tools for complex operations ImageSharp is a great alternarive and can be used in device, cloud, and embedded/IoT scenarios.

You can find more info about the project at sixlabors.com or on GitHub.

Goals for the Session

The mains goals for the session are to allow you to learn something new while contributing to a project that will help thousands of developers in the future. There are a tons of things to do in ImageSharp, from coding smaller features and addressing flaws to engineering new complex areas of functionality. Whether you like designing decoders, tweaking runtime performance, writing tests, or documentation there will undoubtedly be something for you!

How to Contribute

First, start by choosing what you'd like to do - you can have a look at issues up-for-grabs label. (Feel free to suggest other features also though, your ideas are most welcome!). Then fork the repo, clone it locally and your are ready to develop. Finally, create a work-in-progress pull request to the beta-1 branch with the title WIP-{Your issue number}. Make sure that you have merged the latest changes and that the PR has a readable diff (please avoid reformatting documents, refactoring stuff, changing CRLF to LF or tabs to spaces etc.)

Which are the things I can work on?

  • up-for-grabs issues - There is sometimes a brief description how it could be implemented, but feel free to ask if anything is not clear, we will be happy to help.
  • There are two big, hot and high-priority topics now: (1) integration testing, (2) jpeg decoder. We are constantly (re)evaluating the design needs here, so if you want to help with these topics, the best start would be to join our Gitter chatroom, and discuss the details.
  • If you'd like to implement your own feature, I'd recommend you to describe it first in an issue, so we can discuss it and help you with implementation. Sometimes the feature might be already implemented, but just have a different name.

Project Setup

To get started, fork the repository, and clone it on or computer. You can use Github Desktop, Visual Studio's Team Explorer window or run git clone https://github.com/<your_github_username>/ImageSharp.git.

We are using Visual Studio 2017; the solution will not open in previous versions of Visual Studio.

Open the ImageSharp.sln solution in Visual Studio, or open the repository folder in VS Code.

You can also try to rebuild tests/ImageSharp.Tests/ImageSharp.Tests project and run the unit/integration tests - it should complete in few seconds, everything should be green. :)

General Communication

If you have any questions or want to ask anything, you can use a Gitter chat or post a comment in the issue you'd like to work on. Any communication is picked up by all members of the team so there will always be someone around to help you.

Clone this wiki locally
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.