Skip to content

Commit ebcce24

Browse files
sallainsevein
authored andcommitted
Add contributing and security markdown files
1 parent 77f98f1 commit ebcce24

File tree

1 file changed

+52
-0
lines changed

1 file changed

+52
-0
lines changed

CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing
2+
3+
This repository is the place to file a3m bug reports as well as make suggestions
4+
for new or enhanced features. Anyone with a GitHub account can add an issue,
5+
comment on someone else's issue, or make a pull request.
6+
7+
## Security
8+
9+
If you have a security concern about a3m or any of its companion repositories,
10+
please do not file it here. See the [security policy](SECURITY.md) in this
11+
repository for directions on how to report security issues.
12+
13+
## Filing an issue
14+
15+
All changes to a3m should start with an issue, including bug fixes, new
16+
features, and enhancements to existing features.
17+
18+
To file an issue, go to [the Issues
19+
tab](https://github.com/artefactual-labs/a3m/issues) and click the green **New
20+
issue** button in the top right-hand corner. You can select the appropriate
21+
template from the list. Fill out the template with as much information as you
22+
can.
23+
24+
An issue should describe a behaviour without implying a solution. The pull
25+
request that may follow, if changes to the codebase are necessary, fixes the
26+
problem. Framing your issue as a problem statement helps everyone understand why
27+
the issue is important - it describes how Enduro is not performing as it should
28+
(bug) or as it could (enhancement). Please title your issue as a problem
29+
statement, starting with "Problem:". You can check [existing
30+
issues](https://github.com/archivematica/Issues/issues) for examples.
31+
32+
### Reporting a bug
33+
34+
To report a bug, select **Bug report** from the issue templates and fill out the
35+
fields with as much information as possible.
36+
37+
Useful information to provide includes:
38+
39+
* What version of a3m are you using?
40+
* Are you using it with Enduro?
41+
* How was it installed?
42+
* Was this a fresh install or an upgrade?
43+
* What did you do to cause this bug to happen?
44+
* What did you expect to happen?
45+
* What did you see instead?
46+
* Can you reproduce this reliably?
47+
48+
### Submitting an enhancement idea
49+
50+
To suggest a new feature or an enhancement to an existing feature, select
51+
**Feature request** from the issue templates and fill out the fields with as
52+
much information as possible.

0 commit comments

Comments
 (0)