stellar/readme at master · siriushq/stellar · GitHub

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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
siriushq/stellar
================

There are many available sources of documentation for users and contributors.
Rendered source documentation is available in the "target" directory for any
given module after building. https://stellar.sirius.cam houses the handbook.

<!> The handbook is currently not public.

including
=========

A bill-of-materials is provided to control dependency versions.

	pom.xml ===========================================
	<dependencyManagement>
		<dependencies>
			<dependency>
				<groupId>org.siriushq.stellar</groupId>
				<artifactId>stellar-bom</artifactId>
				<version>1.0-RC1</version>
				<scope>import</scope>
				<type>pom</type>
			</dependency>
		</dependencies>
	</dependencyManagement>
	===================================================

Register (& require) any dependencies you need. You should exclude the versions
when using `dependencyManagement` (the above BOM declaration), e.g.:

	pom.xml ====================================
	<dependency>
		<groupId>org.siriushq.stellar</groupId>
		<artifactId>stellar-logging</artifactId>
	</dependency>
	============================================

	module-info.java ===============
	requires sirius.stellar.logging;
	================================

building
========

The preferred environment includes Oracle GraalVM for Java 25 and the Apache
Maven Daemon (mvnd), or any other suitable distribution of Maven.

	$ git clone --recursive git@github.com:siriushq/stellar.git
	$ cd stellar
	$ mvnd package

An installation of GnuPG is required to run the `install` or `deploy` goals
(alternatively, use `-Dgpg.skip` flag to skip, not recommended!)

contributing
============

Contributions are accepted as long as they fall within implied project scope.

All commits must contain at least `Signed-off-by` to identify the author of the
contribution, and may contain `Co-authored-by` to attach any number of other
authors (this can be added automatically with `git commit ... -s ...`).

(furthermore, commits from people with repository write access are to be signed
with a verified GPG, SSH or S/MIME signature attached to your GitHub account).

Relevant documentation should be updated to include accrediting. For example,
JavaDoc comments on type declarations should contain name & GitHub username:

	@author John Doe (jdoe)

By submitting a contribution, you certify that you and other authors are making
your contribution available under the license of the project, and that you have
the rights to submit it.

licensing
=========

This project is licensed under the 3-Clause BSD.
This is being done at our loss. Consider starring this repository and/or buying
our products to support the development and future of this project.

Some portions of this project are adapted from projects with other licenses.
They are clearly marked with `SPDX-License-Identifier` & declared in `pom.xml`.

support
=======

If commercial support is required, it can be granted for users/organizations by
request. Responses will be provided within 24 hours.

This can be obtained by emailing `stellar@mechite.com` with the following
(* for required; please fill all fields using "N/A" for empty optionals):

	example.eml ================================
	To: <stellar@mechite.com>
	Subject: siriushq/stellar commercial support
	Content-Type: text/plain; charset="UTF-8"

	Name *
	Organization
	Role

	Minimum duration commitment required
	Earliest required start date
	============================================