Skip to content

Commit a590007

Browse files
committed
chore: Add take for breaking changes
Signed-off-by: Joern Bernhardt <joern.bernhardt@googlemail.com>
1 parent f9dac7d commit a590007

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,17 @@ cool stuff, please feel free to
147147
[my website](https://narigo.dev/) or by
148148
[opening an issue in the keepass-diff repository](https://github.com/Narigo/keepass-diff/issues/new).
149149

150+
In general, I'm trying to avoid breaking changes with this tool. If you think an
151+
option should be added or made to a default, this can be discussed in an issue.
152+
I would prefer adding an option first and collect multiple of these changes
153+
before releasing a new major version with breaking changes.
154+
150155
### Testing
151156

157+
There are unit tests (`cargo test`) and end-to-end tests (`./run-tests.sh`).
158+
Both test suites help find regressions in the code and should be checked before
159+
sending a pull request.
160+
152161
Password for the Keepass demo files: `demopass`.
153162

154163
`test_file.kdbx` is locked without password and keyfile `keyfile.key`.

docs/index.html

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -146,7 +146,14 @@ <h2 id="contributing">Contributing</h2></h2>
146146
<a href="https://github.com/Narigo">my GitHub profile</a>,
147147
<a href="https://narigo.dev/">my website</a> or by
148148
<a href="https://github.com/Narigo/keepass-diff/issues/new">opening an issue in the keepass-diff repository</a>.</p>
149+
<p>In general, I'm trying to avoid breaking changes with this tool. If you think an
150+
option should be added or made to a default, this can be discussed in an issue.
151+
I would prefer adding an option first and collect multiple of these changes
152+
before releasing a new major version with breaking changes.</p>
149153
<h3 id="testing">Testing</h3></h3>
154+
<p>There are unit tests (<code>cargo test</code>) and end-to-end tests (<code>./run-tests.sh</code>).
155+
Both test suites help find regressions in the code and should be checked before
156+
sending a pull request.</p>
150157
<p>Password for the Keepass demo files: <code>demopass</code>.</p>
151158
<p><code>test_file.kdbx</code> is locked without password and keyfile <code>keyfile.key</code>.
152159
<code>test2_file.kdbx</code> is locked with <code>demopass</code> and the keyfile <code>keyfile.key</code>.</p>

0 commit comments

Comments
 (0)