Skip to content

Commit 6c909a4

Browse files
author
Christopher Tubbs
committedMar 1, 2019
Add skeleton repository files
* Add issue templates * Add contributing guide * Add NOTICE file to accompany Apache 2.0 LICENSE file * Update README
1 parent 64ad1bc commit 6c909a4

File tree

6 files changed

+164
-1
lines changed

6 files changed

+164
-1
lines changed
 

‎.github/ISSUE_TEMPLATE/bug_report.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Environment (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Additional context**
32+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/feature_request.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Question
3+
about: Ask a question from the developers
4+
title: ''
5+
labels: question
6+
assignees: ''
7+
8+
---
9+
10+

‎CONTRIBUTING.md

+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
# Contributors Guide
2+
3+
Ghidra is an open source project. If you are interested in making it better,
4+
there are many ways you can contribute. For example, you can:
5+
6+
- Submit a bug report
7+
- Suggest a new feature
8+
- Provide feedback by commenting on feature requests/proposals
9+
- Propose a patch by submitting a pull request
10+
- Suggest or submit documentation improvements
11+
- Review outstanding pull requests
12+
- Answer questions from other users
13+
- Share the software with other users who are interested
14+
- Teach others to use the software
15+
- Package and distribute the software in a downstream community (such as your
16+
preferred Linux distribution)
17+
18+
Note: Contributing to the open source project is entirely voluntary, and does
19+
not create an employer-employee relationship between the U.S. Government and
20+
the contributor.
21+
22+
## Bugs and Feature Requests
23+
24+
If you believe that you have found a bug or wish to propose a new feature,
25+
please first search the existing [issues] to see if it has already been
26+
reported. If you are unable to find an existing issue, consider using one of
27+
the provided templates to create a new issue and provide as many details as you
28+
can to assist in reproducing the bug or explaining your proposed feature.
29+
30+
## Patch Submission tips
31+
32+
Patches should be submitted in the form of Pull Requests to the Ghidra
33+
[repository] on GitHub. But first, consider the following tips to ensure a
34+
smooth process when submitting a patch:
35+
36+
- Ensure that the patch compiles and does not break any build-time tests
37+
- Be understanding, patient, and friendly; developers may need time to review
38+
your submissions before they can take action or respond. This does not mean
39+
your contribution is not valued. If your contribution has not received a
40+
response in a reasonable time, consider commenting with a polite inquiry for
41+
an update.
42+
- Limit your patches to the smallest reasonable change to achieve your intended
43+
goal. For example, do not make unnecessary indentation changes; but don't go
44+
out of your way to make the patch so minimal that it isn't easy to read,
45+
either. Consider the reviewer's perspective.
46+
- Before submission, please squash your commits to using a message that starts
47+
with the issue number and a description of the changes.
48+
- Isolate multiple patches from each other. If you wish to make several
49+
independent patches, do so in separate, smaller pull requests that can be
50+
reviewed more easily.
51+
- Be prepared to answer questions from reviewers. They may have further
52+
questions before accepting your patch, and may even propose changes. Please
53+
accept this feedback constructively, and not as a rejection of your proposed
54+
change.
55+
56+
## Review
57+
58+
- We welcome code reviews from anyone. A committer is required to formally
59+
accept and merge the changes.
60+
- Reviewers will be looking for things like threading issues, performance
61+
implications, API design, duplication of existing functionality, readability
62+
and code style, avoidance of bloat (scope-creep), etc.
63+
- Reviewers will likely ask questions to better understand your change.
64+
- Reviewers will make comments about changes to your patch:
65+
- MUST means that the change is required
66+
- SHOULD means that the change is suggested, further discussion on the
67+
subject may be required
68+
- COULD means that the change is optional
69+
70+
[issues]: https://github.com/NationalSecurityAgency/ghidra/issues
71+
[repository]: https://github.com/NationalSecurityAgency/ghidra/
72+

‎NOTICE

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
Ghidra
2+
3+
This product includes software developed at National Security Agency
4+
(https://www.nsa.gov)
5+
6+
Portions of this product were created by the U.S. Government and not subject to
7+
U.S. copyright protections under 17 U.S.C.
8+
9+
The remaining portions are copyright their respective authors and have been
10+
contributed under the terms of one or more open source licenses, and made
11+
available to you under the terms of those licenses. (See LICENSE)
12+

‎README.md

+18-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,18 @@
1-
# ghidra
1+
# Ghidra
2+
3+
Ghidra is a soon-to-be-released open source software project created and
4+
maintained by the [National Security Agency][nsa].
5+
6+
This repository is a placeholder. Efforts are under way to make the software
7+
available here. In the meantime, please consider taking a look at our
8+
[contributor guide][contrib] to see how you can participate in this open source
9+
project when it becomes available.
10+
11+
If you are interested in projects like this and would like to develop this, and
12+
other cybersecurity tools, for NSA to help protect our nation and its allies,
13+
consider applying for a [career with us][career].
14+
15+
[nsa]: https://www.nsa.gov
16+
[contrib]: CONTRIBUTING.md
17+
[career]: https://www.intelligencecareers.gov/nsa
18+

0 commit comments

Comments
 (0)
Please sign in to comment.