Skip to content

Commit cfae5f5

Browse files
committed
Add contributing information
1 parent 9864803 commit cfae5f5

File tree

2 files changed

+20
-3
lines changed

2 files changed

+20
-3
lines changed

CONTRIBUTING.md

+16-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,17 @@
1-
# Contributing to Eclipse Platform
2-
See https://github.com/eclipse-platform/.github/blob/main/CONTRIBUTING.md for contributing to Eclipse Platform in general.
1+
# Contributing to Initiative 31's Skija Prototype
32

4-
Additional SWT-specific information can be found in [README.md](README.md).
3+
Thank you for your interest in contributing to this SWT prototyping work.
4+
5+
## Setup and Contribution Workflow
6+
7+
To set up a development environment for testing and developing the prototype, please see the prototype-specific information in the [README](README.md) and the general information about setting up a development environment for Eclipse in the [contributing information](https://github.com/eclipse-platform/.github/blob/main/CONTRIBUTING.md) of the Eclipse platform.
8+
There, you can also find information about how to make pull requests for providing parts that you have implemented to this repository.
9+
You can also reach out to any of the [people involved so far](https://github.com/orgs/swt-initiative31/people) or use our [communication channels](https://github.com/swt-initiative31#contacts) to find out how to contribute your work.
10+
11+
## Potential Work Items
12+
13+
Since this work is still in a prototyping phase with limited resources, we do not a defined roadmap towards a full SWT implementation based on Skia and custom-implemented widgets yet.
14+
Still, we have a list of general tasks that we do currently or need to work on:
15+
- [Roadmap / Tasks](https://github.com/swt-initiative31/prototype-skija/issues/14)
16+
17+
You can have a look into that list to find out which topics might be of interest for you. A good starting point to get familiar with the work is to pick any of the controls that are not custom-implemented so far and try to implement them on your own, i.e., without using the current native implementation of that widget. In case you have any questions on that, please comment to that issue, reach out to any of the current contributors to the project or join any of our [communication channels](https://github.com/swt-initiative31#contacts).

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ This repository is a fork of the original [SWT repository](https://github.com/ec
44

55
In the following, you find information about the current state of the prototype and how to try it out. Note that the prototype does currently not provide other/better look and feel or customizability compared to the native widgets. It is supposed to demonstrate feasibility to custom draw widgets based on an efficient rendering engine (as an enabler for improved customizability and look and feel) while seamlessly integrating the custom-drawn widgets with the other, still native widgets. For that reason, the custom-drawn widgets are currently implemented to look similar to the existing widgets they replace, but they could be easily replaced with whatever look and feel is desired.
66

7+
## How to Contribute
8+
9+
See our [contributing information](CONTRIBUTING.md) to find out how to contribute.
10+
711
## Getting Started
812

913
To test the prototype, an Eclipse IDE has to be set up and the SWT projects from this repository have to be imported into it to start example applications.

0 commit comments

Comments
 (0)