Skip to content

Commit 2868b4b

Browse files
committed
Tweaked project documentation.
This commit makes a few tweaks to the project documentation. Signed-off-by: Jacob Howard <[email protected]>
1 parent 3a78fa2 commit 2868b4b

File tree

4 files changed

+33
-65
lines changed

4 files changed

+33
-65
lines changed

BUILDING.md

+19-14
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,32 @@
11
# Building
22

3-
Mutagen is *not* `go get`able for end-users because it needs to cross-compile
4-
agent binaries for remote platforms and generate a bundle of these binaries. In
5-
general, users should download the release builds from the
6-
[releases page](https://github.com/mutagen-io/mutagen/releases/latest).
7-
8-
Mutagen can, however, be built locally for testing and development. Mutagen
3+
Mutagen's build is slightly unique because it needs to cross-compile agent
4+
binaries for remote platforms (with cgo support in the case of macOS) and then
5+
generate a bundle of these binaries to ship alongside the Mutagen CLI. As such,
6+
using `go get` or `go install` to acquire Mutagen will result in an incomplete
7+
installation, and users should instead download the release builds from the
8+
[releases page](https://github.com/mutagen-io/mutagen/releases/latest) or
9+
[install Mutagen](https://mutagen.io/documentation/introduction/installation)
10+
via [Homebrew](https://brew.sh/).
11+
12+
However, Mutagen can be built locally for testing and development. Mutagen
913
relies on the Go toolchain's module support, so make sure that you have Go
1014
module support enabled.
1115

1216
Individual Mutagen executables can be built normally using the Go toolchain, but
13-
a script is provided to manage cross-compiled builds and agent bundle creation.
14-
To see information about the build script, run:
17+
a script is provided to ensure a normalized build, manage cross-compiled builds
18+
and agent bundle creation, and perform code signing on macOS. To see information
19+
about the build script, run:
1520

1621
go run scripts/build.go --help
1722

1823
The build script can do four different types of builds: `local` (with support
19-
for the local system only), `slim` (with support for a selection of common
20-
platforms used in testing), `release` (used for generating complete release
21-
artifacts), and `release-slim` (used for generating complete release artifacts
22-
for a selection of common platforms used in testing). macOS is currently the
23-
only platform that supports doing `release` builds, because the macOS binaries
24-
require cgo support for file monitoring.
24+
for the local system only), `slim` (the default - with support for a selection
25+
of common platforms used in testing), `release` (used for generating complete
26+
release artifacts), and `release-slim` (used for generating complete release
27+
artifacts for a selection of common platforms used in testing). macOS is
28+
currently the only platform that supports doing `release` builds, because the
29+
macOS binaries require cgo support for filesystem monitoring.
2530

2631
All artifacts from the build are placed in a `build` directory at the root of
2732
the Mutagen source tree. As a convenience, artifacts built for the current

CONTRIBUTING.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@ email us at [[email protected]](mailto:[email protected]).
3030

3131
---
3232

33-
**Please note:** Mutagen is currently in a state of high code churn and I simply
34-
don't have the time to review pull requests. GitHub unfortunately doesn't allow
35-
me to disable pull requests, but please be aware that they will probably be left
36-
on the back burner for the foreseeable future. Sorry :-(
33+
**Please note:** I'm still working on formulating Mutagen's pull request policy.
34+
I'm trying to make it as simple as possible while ensuring code quality and
35+
project longevity. I very much want community contributions, but I haven't had
36+
an extensive amount of time to review pull requests or formulate a review
37+
process. I'm working on changing this, so I ask you to bear with me for just a
38+
little longer. Thank you!
3739

3840
– Jacob
3941

@@ -48,18 +50,16 @@ guidelines. Pull requests that don't follow these guidelines will simply be
4850
closed.
4951

5052

51-
### Developer Certificate of Origin
53+
### Contributor License Agreement
5254

53-
Pull requests to Mutagen must be submitted under the terms of the
54-
[Developer Certificate of Origin (DCO)](DCO). In order to accept a pull request,
55-
we require that you sign-off all commits in the pull request using the `-s` flag
56-
with `git commit` to indicate that you agree to the terms of the DCO.
55+
Mutagen pull requests will require a Contributor License Agreement, though the
56+
exact form of this agreement is still being decided.
5757

5858

5959
### Code guidelines
6060

6161
In order to ensure that Mutagen's codebase remains clean and understandable to
62-
newcomers, we kindly request that:
62+
all developers, we kindly request that:
6363

6464
- Code adheres to Go style guidelines, including those in
6565
[Effective Go](https://golang.org/doc/effective_go.html) and the

DCO

-37
This file was deleted.

SECURITY.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Security
22

3-
If you find a security issue with Mutagen, please DO NOT submit it via the issue
4-
tracker! Instead, please follow responsible disclosure practices and send
5-
information about security issues directly to
3+
If you find a security issue with Mutagen or one of its related projects, please
4+
DO NOT submit it via the issue tracker! Instead, please follow responsible
5+
disclosure practices and send information about security issues directly to
66
[[email protected]](mailto:[email protected]) so that a proper assessment
77
can be made and a fix prepared before a wide announcement. You will receive an
88
acknowledgement within 24 hours. If you do not, please contact the project
@@ -15,4 +15,4 @@ as soon as possible. We can work together to investigate, debug, and assess.
1515
You may also direct questions, feedback, or suggestions about Mutagen's security
1616
policy to the same email addresses.
1717

18-
Your help is greatly appreciated in keeping Mutagen secure!
18+
Your help is greatly appreciated in keeping Mutagen code secure!

0 commit comments

Comments
 (0)