Skip to content

Commit ff86dd1

Browse files
committed
More wording changes
1 parent d41eed9 commit ff86dd1

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,23 @@ Basic Information
1616
What compiler and/or IDE you are using (include version):
1717
1818
If you are using a pre-packaged binary
19-
Exact package name and version: (for example, libarchive13-3.1.2-11)
19+
Exact package name and version:
2020
Repository you obtained it from:
2121
2222
Description of the problem you are seeing:
2323
What did you do?
2424
What did you expect to happen?
25-
What actually happen?
26-
What log files or erorr messages were produced?
25+
What actually happened?
26+
What log files or error messages were produced?
2727
2828
How the libarchive developers can reproduce your problem:
2929
What other software was involved?
3030
What other files were involved?
3131
How can we obtain any of the above?
3232
```
3333

34+
Depending on the specific type of issue, other information will be helpful:
35+
3436
## Test Failures
3537

3638
If you see any test failures, please include the information above and also:
@@ -53,14 +55,18 @@ If you are trying to write a program using libarchive, please include the inform
5355

5456
## Libarchive produced incorrect output
5557

58+
Please tell us what program you ran, any command-line arguments you provided, and details of the input files (`ls -l` output is helpful here). If the problem involved a command-line program, please copy the full terminal text into the report, including the command line and any error messages.
59+
5660
Please try to make the output file available to us. Unless it is very large, you can upload it into a fresh github repository and provide a link in your issue report.
5761

5862

59-
## Libarchive failed to read a particular input file
63+
## Libarchive could not read a particular input file
6064

6165
Note: If you can provide a **very small** input file that reproduces the problem, we can add that to our test suite. This will ensure that the bug does not reappear in the future.
6266

63-
If the input file is large and/or proprietary, please post an issue first, then follow-up with an email to [email protected] so one of the libarchive developers can follow up with you. In your email, please include a link to the issue report.
67+
A link to the relevant file is usually sufficient.
68+
69+
If you cannot provide the input file or a link to the file, please let us know if there is some other way to obtain it.
6470

6571

6672
## Documentation improvements
@@ -78,11 +84,11 @@ We are always interested in improving the libarchive documentation. Please tell
7884

7985
We welcome all code submissions. But of course, some code submissions are easier for us to respond to than others. The best code submissions:
8086

81-
* Address a single issue. There have been many cases where a simple fix to an obvious problem did not get handled for months because the patch that was provided also included an unrelated change affecting a controversial area of the code.
87+
* Address a single issue. There have been many cases where a simple fix to an obvious problem did not get handled for months because the patch that was provided also included an unrelated change affecting an especially complex area of the code.
8288

8389
* Follow existing libarchive code style and conventions. Libarchive generally follows [BSD KNF](https://www.freebsd.org/cgi/man.cgi?query=style&sektion=9) for formatting code.
8490

85-
* Do not make gratuitous changes to existing whitespace, capitalization, or spelling.
91+
* Do not make unnecessary changes to existing whitespace, capitalization, or spelling.
8692

8793
* Include detailed instructions for reproducing the problem you're fixing. We do try to verify that a submission actually fixes a real problem. If we can't reproduce the problem, it will take us longer to evaluate the fix. For this reason, we encourage you to file an issue report first with details on reproducing the problem, then refer to that issue in your pull request.
8894

0 commit comments

Comments
 (0)