Skip to content

Commit

Permalink
contributing: Use word addon consistently (#929)
Browse files Browse the repository at this point in the history
- Use addon as a word (replace all AddOn by addon).
- Remove git (Git) from title. No need to distinguish from Subversion. Use the word code, to distinguish it from documentation or from a place where binaries or such things would be uploaded.
- Simplify the sentences by removing repetitions of GRASS...addon... where repository is enough.
- Name the cloned directory just like the repo is named, but still be explicit.
- Mention the compilation with g.extension (other compilation instructions would still use some improvements).
- Use addon as an adjective and don't say addons modules.
- Consider scripts as modules (both C and Python can be a module, i.e., a tool).
- Mention RFC2 first, write access only at the end.
- Replace Track wiki links by GitHub source code where possible.
  • Loading branch information
wenzeslaus committed Jul 18, 2023
1 parent fca644a commit a2c75eb
Showing 1 changed file with 24 additions and 22 deletions.
46 changes: 24 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,27 @@
# GRASS Addons git repository
# GRASS GIS Addons Code Repository

## How to get the AddOn code
## How to get the addon code

Clone of the entire AddOns git repository:
Clone of the entire repository:

```bash
git clone https://github.com/OSGeo/grass-addons.git grass_addons
git clone https://github.com/OSGeo/grass-addons.git grass-addons
```

## How to install or remove AddOns in your GRASS installation
## How to install or remove addons in your GRASS installation

The simplest way to install GRASS GIS AddOns is to use the `g.extension`
The simplest way to install GRASS GIS Addons is to use the `g.extension`
module:
<https://grass.osgeo.org/grass-stable/manuals/g.extension.html>

## How to compile AddOn code
`g.extension` can install from the online repository (the default) or from
local source code (not available on Windows).

## How to compile addon code

### Compilation with GRASS GIS binaries on your computer

In this case, compile GRASS AddOns modules into your installed GRASS code
In this case, compile GRASS addon modules into your installed GRASS code
by setting `MODULE_TOPDIR` to where to the GRASS binaries are located:

```bash
Expand All @@ -39,16 +42,16 @@ or commit used for the binary.)
make
```

The easiest way to compile GRASS AddOns modules into your GRASS code
The easiest way to compile GRASS addons modules into your GRASS code
is by setting `MODULE_TOPDIR` on the fly to tell `make` where to
find the prepared GRASS source code:

```bash
make MODULE_TOPDIR=$HOME/grass/
```

(adapt as needed to your `/path/to/grass/`). Each module/script in the GRASS
AddOns git repository should have a Makefile to support easy
(adapt as needed to your `/path/to/grass/`). Each module in the GRASS
Addons repository should have a Makefile to support easy
installation.

Install then into your existing GRASS installation with
Expand All @@ -57,29 +60,28 @@ Install then into your existing GRASS installation with
make MODULE_TOPDIR=$HOME/grass/ install
```

For system-wide installation this usually requires "root" privileges
For system-wide installation the install step usually requires "root" privileges
(so, also `sudo` may help).

## How to submit your contributions

While read access is granted to the public, for submissions you best fork
this repository, insert your AddOn or fix an existing one in a new branch
this repository, insert your addon or fix an existing one in a new branch
and finally open a [pull request](https://help.github.com/en/articles/about-pull-requests).

If you aim at full write access, this must be formally requested, see here for details:
<https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository>

In either case, please note the following submitting rules: To successfully
submit your GRASS GIS AddOn module here, please check
Please note the following submitting rules: To successfully
submit your GRASS GIS Addon module here, please check

<https://grass.osgeo.org/development/>

Your submission must be compliant with the GRASS
submission rules as found in the GRASS source code
and RFC2 (Legal aspects of submission):
and [RFC2 (Legal aspects of submission)](https://github.com/OSGeo/grass/blob/main/doc/development/rfc/legal_aspects_of_code_contributions.md).

<https://trac.osgeo.org/grass/wiki/RFC>
Also please read submitting instructions before creating a pull request:

Also read submitting instructions before committing any changes!
<https://github.com/OSGeo/grass/tree/main/doc/development/submitting>

<https://trac.osgeo.org/grass/wiki/Submitting>
If you aim at becomming code maintainer with full write access, this must be
formally requested, see here for details:
<https://trac.osgeo.org/grass/wiki/HowToContribute#WriteaccesstotheGRASSaddonsrepository>

0 comments on commit a2c75eb

Please sign in to comment.