From 6c909a46cdb9f56af0be73062852ccac79ee89a1 Mon Sep 17 00:00:00 2001 From: Christopher Tubbs Date: Thu, 28 Feb 2019 22:43:12 -0500 Subject: [PATCH] Add skeleton repository files * Add issue templates * Add contributing guide * Add NOTICE file to accompany Apache 2.0 LICENSE file * Update README --- .github/ISSUE_TEMPLATE/bug_report.md | 32 ++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++ .github/ISSUE_TEMPLATE/question.md | 10 ++++ CONTRIBUTING.md | 72 +++++++++++++++++++++++ NOTICE | 12 ++++ README.md | 19 +++++- 6 files changed, 164 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 CONTRIBUTING.md create mode 100644 NOTICE diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000000..f1878103b1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,32 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Environment (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000000..11fc491ef1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000000..d26942d863 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,10 @@ +--- +name: Question +about: Ask a question from the developers +title: '' +labels: question +assignees: '' + +--- + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000000..26f2a0d43d --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,72 @@ +# Contributors Guide + +Ghidra is an open source project. If you are interested in making it better, +there are many ways you can contribute. For example, you can: + +- Submit a bug report +- Suggest a new feature +- Provide feedback by commenting on feature requests/proposals +- Propose a patch by submitting a pull request +- Suggest or submit documentation improvements +- Review outstanding pull requests +- Answer questions from other users +- Share the software with other users who are interested +- Teach others to use the software +- Package and distribute the software in a downstream community (such as your + preferred Linux distribution) + +Note: Contributing to the open source project is entirely voluntary, and does +not create an employer-employee relationship between the U.S. Government and +the contributor. + +## Bugs and Feature Requests + +If you believe that you have found a bug or wish to propose a new feature, +please first search the existing [issues] to see if it has already been +reported. If you are unable to find an existing issue, consider using one of +the provided templates to create a new issue and provide as many details as you +can to assist in reproducing the bug or explaining your proposed feature. + +## Patch Submission tips + +Patches should be submitted in the form of Pull Requests to the Ghidra +[repository] on GitHub. But first, consider the following tips to ensure a +smooth process when submitting a patch: + +- Ensure that the patch compiles and does not break any build-time tests +- Be understanding, patient, and friendly; developers may need time to review + your submissions before they can take action or respond. This does not mean + your contribution is not valued. If your contribution has not received a + response in a reasonable time, consider commenting with a polite inquiry for + an update. +- Limit your patches to the smallest reasonable change to achieve your intended + goal. For example, do not make unnecessary indentation changes; but don't go + out of your way to make the patch so minimal that it isn't easy to read, + either. Consider the reviewer's perspective. +- Before submission, please squash your commits to using a message that starts + with the issue number and a description of the changes. +- Isolate multiple patches from each other. If you wish to make several + independent patches, do so in separate, smaller pull requests that can be + reviewed more easily. +- Be prepared to answer questions from reviewers. They may have further + questions before accepting your patch, and may even propose changes. Please + accept this feedback constructively, and not as a rejection of your proposed + change. + +## Review + +- We welcome code reviews from anyone. A committer is required to formally + accept and merge the changes. +- Reviewers will be looking for things like threading issues, performance + implications, API design, duplication of existing functionality, readability + and code style, avoidance of bloat (scope-creep), etc. +- Reviewers will likely ask questions to better understand your change. +- Reviewers will make comments about changes to your patch: + - MUST means that the change is required + - SHOULD means that the change is suggested, further discussion on the + subject may be required + - COULD means that the change is optional + +[issues]: https://github.com/NationalSecurityAgency/ghidra/issues +[repository]: https://github.com/NationalSecurityAgency/ghidra/ + diff --git a/NOTICE b/NOTICE new file mode 100644 index 0000000000..bdbe9fb8e2 --- /dev/null +++ b/NOTICE @@ -0,0 +1,12 @@ +Ghidra + +This product includes software developed at National Security Agency +(https://www.nsa.gov) + +Portions of this product were created by the U.S. Government and not subject to +U.S. copyright protections under 17 U.S.C. + +The remaining portions are copyright their respective authors and have been +contributed under the terms of one or more open source licenses, and made +available to you under the terms of those licenses. (See LICENSE) + diff --git a/README.md b/README.md index 65c505e2c7..e550e52f82 100644 --- a/README.md +++ b/README.md @@ -1 +1,18 @@ -# ghidra \ No newline at end of file +# Ghidra + +Ghidra is a soon-to-be-released open source software project created and +maintained by the [National Security Agency][nsa]. + +This repository is a placeholder. Efforts are under way to make the software +available here. In the meantime, please consider taking a look at our +[contributor guide][contrib] to see how you can participate in this open source +project when it becomes available. + +If you are interested in projects like this and would like to develop this, and +other cybersecurity tools, for NSA to help protect our nation and its allies, +consider applying for a [career with us][career]. + +[nsa]: https://www.nsa.gov +[contrib]: CONTRIBUTING.md +[career]: https://www.intelligencecareers.gov/nsa +