forked from snapcrafters/eclipse
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.md.orig
87 lines (58 loc) · 4.79 KB
/
README.md.orig
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
<h1 align="center">
<img src="https://www.eclipse.org/org/artwork/images/eclipse_ide_logo.png" alt="Eclipse">
</h1>
<p align="center"><b>This is the snap for Eclipse</b>. It is a community-maintained package to easily install Eclipse on Ubuntu, Fedora, Debian and other major Linux distributions. It is available in the Snap Store, Ubuntu Software, and a number of other applications.</p>
<p align="center"><i>"An amazing open source community of Tools, Projects and Collaborative Working Groups."</i></p>
<p align="center">
<a href="https://snapcraft.io/eclipse"><img src="https://snapcraft.io/eclipse/badge.svg" alt="Snap Status"></a>
<a href="https://github.com/snapcrafters/eclipse/actions/workflows/sync-upstream.yml"><img src="https://github.com/snapcrafters/eclipse/actions/workflows/sync-upstream.yml/badge.svg"></a>
<a href="https://github.com/snapcrafters/eclipse/actions/workflows/release-to-candidate.yml"><img src="https://github.com/snapcrafters/eclipse/actions/workflows/release-to-candidate.yml/badge.svg"></a>
<a href="https://github.com/snapcrafters/eclipse/actions/workflows/promote-to-stable.yml"><img src="https://github.com/snapcrafters/eclipse/actions/workflows/promote-to-stable.yml/badge.svg"></a>
</p>
## Install
```shell
snap install eclipse
```
([Don't have snapd installed?](https://snapcraft.io/docs/core/install))
<p align="center">Published for <img src="https://raw.githubusercontent.com/anythingcodes/slack-emoji-for-techies/gh-pages/emoji/tux.png" align="top" width="24" /> with :gift_heart: by Snapcrafters</p>
## How to contribute to this snap
Thanks for your interest! Below you find instructions to help you contribute to this snap.
The general workflow is to submit pull requests that merges your changes into the `candidate` branch here on GitHub. Once the pull request has been merged, a GitHub action will automatically build the snap and publish it to the `candidate` channel in the Snap Store. Once the snap has been tested thoroughly, we promote it to the `stable` channel so all our users get it!
### Initial setup
If this is your first time contributing to this snap, you first need to set up your own fork of this repository.
1. [Fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) into your own GitHub namespace.
2. [Clone your fork](https://git-scm.com/book/en/v2/Git-Basics-Getting-a-Git-Repository), so that you have it on your local computer.
3. Configure your local repo. To make things a bit more intuitive, we will rename your fork's remote to `myfork`, and add the snapcrafters repo as `snapcrafters`.
```shell
git remote rename origin myfork
git remote add snapcrafters https://github.com/snapcrafters/eclipse.git
git fetch --all
```
### Submitting changes in a pull request
Once you're all setup for contributing, keep in mind that you want the git information to be all up-to-date. So if you haven't "fetched" all changes in a while, start with that:
```shell
git fetch --all -p
```
Now that your git metadata has been updated you are ready to create a bugfix branch, make your changes, and open a pull request.
1. All pull requests should go to the stable branch so create your branch as a copy of the stable branch:
```shell
git checkout -b my-bugfix-branch snapcrafters/candidate
```
2. Make your desired changes and build a snap locally for testing:
```shell
snapcraft --use-lxd
```
3. After you are happy with your changes, commit them and push them to your fork so they are available on GitHub:
```shell
git commit -a
git push -u myfork my-bugfix-branch
```
4. Then, [open up a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) from your `my-bugfix-branch` to the `snapcrafters/candidate` branch.
5. Once you've opened the pull request, it will automatically trigger the build-test action that will launch a build of the snap. You can watch the progress of the snap build from your pull request (Show all checks -> Details). Once the snap build has completed, you can find the built snap (to test with) under "Artifacts".
6. Someone from the team will review the open pull request and either merge it or start a discussion with you with additional changes or clarification needed.
7. Once the pull request has been merged into the stable branch, a GitHub action will rebuild the snap using your changes and publish it to the [Snap Store](https://snapcraft.io/eclipse) into the `candidate` channel. After sufficient testing of the snap from the candidate channel, one of the maintainers or administrators will promote the snap to the stable branch in the Snap Store.
## Maintainers
- [@thymythos](https://github.com/thymythos/)
## License
- The license of the build files in this repository is MIT
- Eclipse is licensed as EPL-2.0