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.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[refactor] Fork of eXist-db from their git develop branch, commit: adaa276b9cfcaaeb4ee03ee3822ab882e6779f77 (Fri Oct 25 21:27:35 2024 +0200). The Git history was then rewritten to remove many historic files that we no longer need. This resulted in our commit: [e065a83bf4dc94abfeebcc353cbfbd496976f440](e065a83)
Copy file name to clipboardExpand all lines: .github/PULL_REQUEST_TEMPLATE.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,10 +3,10 @@ Thank you for your contribution to eXist-db!
3
3
To help the community judge your pull request (PR), please include the following:
4
4
5
5
- A (short) description of the content of changes.
6
-
- A context reference to a [Github Issue](https://github.com/eXist-db/exist/issues), a message in the [eXist-open mailinglist](http://exist-open.markmail.org), or a [specification](https://www.w3.org/TR/xquery-31/).
6
+
- A context reference to a [Github Issue](https://github.com/evolvedbinary/elemental/issues), a message in the [eXist-open mailinglist](http://exist-open.markmail.org), or a [specification](https://www.w3.org/TR/xquery-31/).
7
7
- Tests. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via XQuery > Run as Test.
8
8
9
-
Your PR will be tested using [GitHub Actions](https://github.com/eXist-db/exist/actions) against a number of operating systems and environments. The build status is visible in the PR.
9
+
Your PR will be tested using [GitHub Actions](https://github.com/evolvedbinary/elemental/actions) against a number of operating systems and environments. The build status is visible in the PR.
10
10
11
11
To detect errors in your PR before submitting it, please run eXist's full test suite on your own system via `mvn -V clean verify`.
eXist-db itself is written in Java 17. The build system is [Apache Maven](http://maven.apache.org/). If you're not familiar with Git, we recommend [this excellent online interactive tutorial](http://try.github.io).
Further build options can be found at: [eXist-db Build Documentation](http://www.exist-db.org/exist/apps/doc/exist-building.xml"How to build eXist").
26
25
27
26
**NOTE:**
28
-
In the above example, we switched the current (checked-out) branch from `develop` to `master`. We use the [GitFlow for eXist-db](#contributing-to-exist) process:
29
-
-`develop` is the current (and stable) work-in-progress (the next release)
30
-
-`master` is the latest release
27
+
In the above example, we switched the current (checked-out) branch from `main` to `gold`.
28
+
-`main` is the current (and stable) work-in-progress (the next release)
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+22-24Lines changed: 22 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,12 +8,10 @@ We follow a "Hub and Spoke" like development model; therefore you should fork ou
8
8
eXist-db uses a [GitFlow](http://nvie.com/git-model)-like branching model for development.
9
9
10
10
The names of each branch should reflect their purpose, the following branches may be of interest:
11
-
*`develop` - the main line of development for the next version of eXist-db.
12
-
*`master` - reflects the `tag` of the last released version of eXist-db.
11
+
*`main` - the main line of development for the next version of eXist-db.
12
+
*`gold` - reflects the `tag` of the last released version of eXist-db.
13
13
14
14
There are also branches that enable us to backport hot-fixes and features to older major versions of eXist-db, so that we might release small updates occasionally.
15
-
*`develop-4.x.x` - development of the 4.x.x version line of eXist-db, mostly now only used for hot-fixes.
16
-
*`develop-5.x.x` - development of the 5.x.x version line of eXist-db.
17
15
*`develop-6.x.x` - development of the 6.x.x version line of eXist-db.
18
16
19
17
When contributing to eXist-db you should branch one of the development branches above, your branch should be named in one of two ways:
@@ -54,7 +52,7 @@ Our controlled list of commit labels that should be prefixed to each commit summ
54
52
55
53
In addition any commit that addresses a GitHub issue, should have an additonal line in its commit after the summary and before any fuller explaination that takes this form:
We now store the path of Jar files in each EXPath Package's `.exist/classpath.txt` file relative to the package's `content/` sub-folder.
68
66
```
69
67
70
68
## Pull Requests and Code Review
71
69
Pull requests are reviewed and tested before they're merged by the eXist-db Core Development Team.
72
-
We have a policy around how pull requests are reviewed in a timely and fair manner. That policy is available here - [Community Code Review and Merge Policy for the exist-db/exist Git Repository](PR-CODE-REVIEW-POLICY.md).
70
+
We have a policy around how pull requests are reviewed in a timely and fair manner. That policy is available here - [Community Code Review and Merge Policy for the evolvedbinary/elemental Git Repository](PR-CODE-REVIEW-POLICY.md).
73
71
Worth restating, is the one "golden rule", even within the Core Team, **no developer should merge their own pull request**. This simple-but-important rule ensures that at least two people have considered the change.
74
72
75
73
Although the following are taken from our [Developer Manifesto](http://www.exist-db.org/exist/apps/doc/devguide_manifesto.xml"eXist Project Developer Manifesto") and [Code Review Guide](http://www.exist-db.org/exist/apps/doc/devguide_codereview.xml"eXist Project Code Review Guide"), the main things that get a pull request accepted are:
@@ -105,7 +103,7 @@ Assuming the stable is `6.x.x` and the RC is `7.x.x`
105
103
- open a second PR from `6.x.x/feature/<name-of-my-feature>` against `develop-6.x.x` mentioning the original PR in the commit message
106
104
107
105
### Forward-port
108
-
Works just as backport but with `feature/<name-of-my-feature>` and `develop`
106
+
Works just as backport but with `feature/<name-of-my-feature>` and `main`
109
107
110
108
111
109
## Syncing a Fork
@@ -122,14 +120,14 @@ Lets say that you have a fork of eXist-db's GitHub repo, and you have been worki
122
120
123
121
1. If you have any un-committed changes you need to stash them using: `git stash save "changes before rebase"`.
124
122
125
-
2. If you have not added eXist-db's GitHub as an upstream remote, you need to do so once by running `git remote add upstream https://github.com/exist-db/exist.git`. You can view your existing remotes, by running `git remote -v`.
123
+
2. If you have not added eXist-db's GitHub as an upstream remote, you need to do so once by running `git remote add upstream https://github.com/evolvedbinary/elemental.git`. You can view your existing remotes, by running `git remote -v`.
126
124
127
125
3. You need to fetch the latest changes from eXist-db's GitHub: `git fetch upstream`. This will not yet change your local branches in any way.
128
126
129
-
4. You should first sync your `develop` branch with eXist-db's `develop` branch. As you always work in feature branches, this should a simple fast-forward by running: `git checkout develop` and then `git rebase upstream/develop`.
130
-
1. If all goes well in (4) then you can push your `develop` branch to your remote server (e.g. GitHub) with `git push origin develop`.
127
+
4. You should first sync your `main` branch with eXist-db's `main` branch. As you always work in feature branches, this should a simple fast-forward by running: `git checkout main` and then `git rebase upstream/main`.
128
+
1. If all goes well in (4) then you can push your `main` branch to your remote server (e.g. GitHub) with `git push origin main`.
131
129
132
-
5. You can then replay your work in your feature branch `feature/my-feature` atop the lastest changes from the `develop` branch by running: `git checkout feature/my-feature` and then `git rebase develop`.
130
+
5. You can then replay your work in your feature branch `feature/my-feature` atop the lastest changes from the `main` branch by running: `git checkout feature/my-feature` and then `git rebase main`.
133
131
1. Should you encounter any conflicts during (5) you can resolve them using `git mergetool` and then `git rebase --continue`.
134
132
2. If all goes well in (5), and take care to check your history is correct with `git log`, then you can force push your `feature/my-feature` branch to your remote server (e.g. GitHub) with `git push -f origin feature/my-feature`. *NOTE* the reason you need to use the `-f` to force the push is because the commit ids of your revisions will have changed after the rebase.
135
133
@@ -150,10 +148,10 @@ If you wish to contribute, the general approach using GitFlow AVH Edition is:
150
148
- Do your stuff! :-)
151
149
- Commit to your repo. We like small, atomic commits that don't mix concerns.
152
150
-**Do NOT** finish the `hotfix` or `feature` with GitFlow.
153
-
- Make sure your branch is based on the latest eXist develop branch before making a pull request. This will ensure that we can easily merge in your changes. See [Syncing a Fork](#syncing-a-fork).
151
+
- Make sure your branch is based on the latest eXist-db `main` branch before making a pull request. This will ensure that we can easily merge in your changes. See [Syncing a Fork](#syncing-a-fork).
154
152
- Push your hotfix or feature branch to your GitHub using GitFlow: `git flow feature publish my-feature`.
155
-
- Send us a pull request on GitHub from your branch to our develop branch.
156
-
- Once the pull request is merged you can delete your branch, you need not finish or merge it, you will however want to sync your develop branch to bring back your changes. See [Syncing a Fork](#syncing-a-fork).
153
+
- Send us a pull request on GitHub from your branch to our `main` branch.
154
+
- Once the pull request is merged you can delete your branch, you need not finish or merge it, you will however want to sync your `main` branch to bring back your changes. See [Syncing a Fork](#syncing-a-fork).
157
155
158
156
### Our `git-flow init` settings
159
157
When we started working with the eXist repo we needed to configure it for GitFlow:
@@ -162,9 +160,9 @@ When we started working with the eXist repo we needed to configure it for GitFlo
162
160
$ git flow init
163
161
164
162
Which branch should be used for bringing forth production releases?
165
-
- master
166
-
Branch name for production releases: [master]
167
-
Branch name for"next release" development: [develop]
163
+
- main
164
+
Branch name for production releases: [gold]
165
+
Branch name for"next release" development: [main]
168
166
169
167
How to name your supporting branch prefixes?
170
168
Feature branches? [feature/]
@@ -175,13 +173,13 @@ Version tag prefix? [] eXist-
175
173
Hooks and filters directory? [.git/hooks]
176
174
```
177
175
178
-
A new `develop` branch is created, and checked out.
176
+
A new `main` branch is created, and checked out.
179
177
180
178
Verify it like this:
181
179
182
180
```bash
183
181
$ git status
184
-
# On branch develop
182
+
# On branch main
185
183
```
186
184
187
185
As we have already started with GitFlow, when you run `git flow init`, you'll get slightly different prompts--but the same answers apply!
@@ -192,12 +190,12 @@ You **must** use the following settings:
192
190
$ git flow init
193
191
194
192
Which branch should be used for bringing forth production releases?
195
-
- develop
196
-
Branch name for production releases: [] master
193
+
- main
194
+
Branch name for production releases: [] gold
197
195
198
196
Which branch should be used for integration of the "next release"?
199
-
- develop
200
-
Branch name for"next release" development: [develop]
0 commit comments