Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Revert "Removing some typos from the readme file"

This reverts commit ecdd11e.
  • Loading branch information...
commit f015a0d0e8d8df189b735c1e674c075081c768e5 1 parent ecdd11e
@jensopetersen jensopetersen authored
Showing with 10 additions and 10 deletions.
  1. +10 −10 README.md
View
20 README.md
@@ -1,7 +1,7 @@
eXist Native XML Database
=========================
-This is the GitHub for the [eXist](http://www.exist-db.org "eXist") Native XML Database. If you are looking to work with the source code of eXist, you have come to the right place, if not you are probably looking for the [eXist Documentation](http://www.exist-db.org/exist/apps/doc/ "Documentation of eXist").
+This is the GitHub for the [eXist](http://www.exist-db.org "eXist") Native XML Database. If you are looking to work with the Source code of eXist you have come to the right place, if not you are probably looking for the [eXist Documentation](http://www.exist-db.org/exist/apps/doc/ "Documentation of eXist").
If you are looking for help or discussion, you should visit the eXist community [mailing lists](http://www.exist-db.org/exist/apps/doc/getting-help.xml "eXist Mailing Lists").
@@ -11,7 +11,7 @@ If you wish to work with the eXist source code we are now using [Git](http://git
Building eXist from Source
--------------------------
-eXist itself is written predominantly in Java 6, and its build system is [Apache Ant](http://ant.apache.org/ "The Apache Ant Project").
+eXist itself is written predominantly in Java 6, and it's build system is [Apache Ant](http://ant.apache.org/ "The Apache Ant Project").
The steps for building eXist are:
- Checkout the Git Repository
@@ -26,7 +26,7 @@ $ ./build.sh
**Note** In the above example, we switch the checked out branch of eXist from "develop" to "master". We are making use of [GitFlow for eXist](#contributing-to-exist), and as such "develop" is our current stable work in progress which will eventually become the next release version, whereas "master" is always the last released version. The choice of which to use is entirely yours.
-**Hint** In the above example, we use the SSH form of the GitHub repo URL to clone eXist, however if you are behind a HTTP Proxy Server and your organisation does not permit outgoing SSH connections (which is true of many larger organisations), then you should instead try the HTTPS URL for our GitHub repo, i.e. https://github.com/eXist-db/exist.git.
+**Hint** In the above example, we use the SSH form of the GitHub repo URL to clone eXist, however if you are behind a HTTP Proxy Server and your organisation does not permit outgoing SSH connections (which is true of many larger organisations) then you should instead try the HTTPS URL for our GitHub repo, i.e. https://github.com/eXist-db/exist.git.
From here, you now have a compiled version of eXist that you may use just as you would an installed version of eXist, however it may be desirable to package this up for easy installation elsewhere. If you wish to create a simple Zip distribution of eXist you can optionally run:
```bash
@@ -53,10 +53,10 @@ We welcome all contributions to eXist.
We strongly suggest that you join the [eXist-development mailing](https://lists.sourceforge.net/lists/listinfo/exist-development "eXist Development Mailing List") list and also subscribe to the [eXist-commits mailing list](https://lists.sourceforge.net/lists/listinfo/exist-commits "eXist SCM Commits Mailing List"), so that you can collaborate with the eXist team and be kept up to date with changes to the codebase.
-eXist uses [GitFlow](http://nvie.com/git-model) as its code management methodology. Specifically we are using the [AVH Edition of GitFlow tools](https://github.com/petervanderdoes/gitflow) version.
+eXist uses [GitFlow](http://nvie.com/git-model) as it's code management methodology. Specifically we are using the [AVH Edition of GitFlow tools](https://github.com/petervanderdoes/gitflow) version.
If you do not know GitFlow, there are several good tutorials linked from the [Getting Started part](https://github.com/petervanderdoes/gitflow#getting-started) of the GitFlow AVH Edition page. Also there is a very good [git-flow cheatsheet](http://danielkummer.github.io/git-flow-cheatsheet/).
-If you wish to contribute, the general approach is:
+If you wish to contribute the general approach is:
- Fork the Repo to your own GitHub
- Clone your Fork
@@ -64,19 +64,19 @@ If you wish to contribute, the general approach is:
- Run git flow init on the cloned repo using these [settings](#our-git-flow-init-settings).
- Use Git Flow to *start* a hotfix or feature i.e. git flow feature start *my-magic-feature*
- Do your stuff :-)
-- Make commit(s) to your repo. We like small atomic commits that do not mix concerns!
+- Commit(s) to your repo. We like small atomic commits that do not mix concerns!
- Use Git Flow to finish the hotfix or feature. *WARN* - If you are using a hotfix, the current advice is not to tag it, as there is no way to send an unknown branch from your fork to upstream using a Pull Request on GitHub.
- Push your hotfix or feature branch to your GitHub using GitFlow, i.e. git flow feature publish *my-magic-feature*
- Send us a Pull Request
All Pull Requests are reviewed and tested before they are merged by the core development team.
-However, we have one golden rule, even within the core team, **no developer may ever merge his own pull request**. This simple but important rule ensures that at least two people have considered the change.
+However we have one golden rule, even within the core team, **no developer may ever merge his own pull request**. This simple but important rule ensures that at least two people have consisered the change.
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 will help us to merge your Pull Request:
-- Only change what you need to. If you must reformat code, keep it in a separate commit to any syntax or functionality changes.
-- Test. If you fix something, prove it, that is , write a test that illustrates the issue before you fixed the issue and validate the test. If you add a new feature, it needs tests, so that we can understand its intent and try to avoid regressions in future as much as possible.
-- Make sure the appropriate licence header appears at the top of your source code file. We use [LGPL v2.1](http://opensource.org/licenses/LGPL-2.1 "The GNU Lesser General Public License, version 2.1") for eXist and *strongly* encourage that, but ultimately any compatible [OSI approved license](http://opensource.org/licenses "Open Source Licenses") without further restrictions may be used.
+- Only change what you need to. If you must reformat code, keep it in a seperate commit to any syntax or functionality changes.
+- Test. If you fix something prove it, write a test that illustrates the issue before you fix the issue and validate the test. If you add a new feature it needs tests, so that we can understand its intent and try to avoid regressions in future as much as possible.
+- Make sure the approriate licence header appears at the top of your source code file. We use [LGPL v2.1](http://opensource.org/licenses/LGPL-2.1 "The GNU Lesser General Public License, version 2.1") for eXist and *strongly* encourage that, but ultimately any compatible [OSI approved license](http://opensource.org/licenses "Open Source Licenses") without further restrictions may be used.
- Run the full eXist test suite. We do not accept code that causes regressions.
Is a bug-fix a feature of hotfix?
Please sign in to comment.
Something went wrong with that request. Please try again.