Skip to content

Commit f40b28e

Browse files
authored
Open source release readiness (#3)
* Open source release readiness 1 * Revise initial CODEOWNERS
1 parent e09f9ee commit f40b28e

File tree

7 files changed

+167
-8
lines changed

7 files changed

+167
-8
lines changed

CODEOWNERS

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
# This repository is maintained by:
2+
* @data-douser @advanced-security/es-codeql

CODE_OF_CONDUCT.md

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, gender identity and expression, level of experience,
9+
nationality, personal appearance, race, religion, or sexual identity and
10+
orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
- Using welcoming and inclusive language
18+
- Being respectful of differing viewpoints and experiences
19+
- Gracefully accepting constructive criticism
20+
- Focusing on what is best for the community
21+
- Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
- The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
- Trolling, insulting/derogatory comments, and personal or political attacks
28+
- Public or private harassment
29+
- Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
- Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at <[email protected]>. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at [http://contributor-covenant.org/version/1/4][version]
72+
73+
[homepage]: http://contributor-covenant.org
74+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
## Contributing
2+
3+
[fork]: https://github.com/advanced-security/codeql-development-template/fork
4+
[pr]: https://github.com/advanced-security/codeql-development-template/compare
5+
6+
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
7+
8+
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE.txt).
9+
10+
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
11+
12+
## Submitting a pull request
13+
14+
1. [Fork][fork] and clone the repository
15+
1. Configure and install the dependencies: `script/bootstrap`
16+
1. Create a new branch: `git checkout -b my-branch-name`
17+
1. Make your change.
18+
1. Run `npm run tidy` to enforce format / lint requirements.
19+
1. Push to your fork and [submit a pull request][pr]
20+
1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
21+
22+
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
23+
24+
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
25+
- Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
26+
27+
## Resources
28+
29+
- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
30+
- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
31+
- [GitHub Help](https://help.github.com)
File renamed without changes.

README.md

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# CodeQL Development Template
1+
# codeql-development-template
22

33
> **Lowering the barrier to entry for CodeQL development through natural language and GitHub Copilot**
44
55
A GitHub repository template for building custom CodeQL queries with AI assistance. This template provides a structured environment with prompts, instructions, and workflows designed to guide GitHub Copilot Coding Agent through the complete CodeQL development lifecycle.
66

7-
## 🎯 Purpose
7+
## Background
88

99
This repository template enables developers to create custom CodeQL security queries with minimal CodeQL expertise by leveraging:
1010

@@ -13,15 +13,15 @@ This repository template enables developers to create custom CodeQL security que
1313
- **Test-driven development methodology** for reliable query creation
1414
- **Pre-configured workflows** for setup, testing, and validation
1515

16-
## Requirements
16+
## Requirements
1717

1818
Before using this repository template, ensure your GitHub organization/account has:
1919

2020
- **GitHub Actions** enabled for running CI/CD workflows
2121
- **GitHub Copilot Coding Agent** access for AI-assisted development
2222
- **GitHub Advanced Security** (optional, but recommended)
2323

24-
## 🚀 Getting Started
24+
## Getting Started
2525

2626
### Step 1: Create a New Repository from Template
2727

@@ -74,7 +74,7 @@ Before using this repository template, ensure your GitHub organization/account h
7474
| [Update existing CodeQL Query](.github/ISSUE_TEMPLATE/query-update.yml) | Modify an existing query to improve accuracy or add new detection capabilities |
7575
| [Improve Prompts/Instructions](.github/ISSUE_TEMPLATE/prompt-update.yml) | Contribute improvements to the AI guidance system |
7676

77-
## 🏗️ Repository Structure
77+
## Repository Structure
7878

7979
After creating your first query, your repository will contain:
8080

@@ -101,7 +101,7 @@ codeql-development-template/
101101
└── scripts/ # Setup and automation scripts
102102
```
103103

104-
## 🎓 How It Works
104+
## How It Works
105105

106106
This template implements a **hierarchical prompt system** that maximizes GitHub Copilot's effectiveness:
107107

@@ -121,7 +121,7 @@ The Copilot Coding Agent uses this hierarchy to:
121121

122122
See [PROMPTS.md](PROMPTS.md) for details on the prompt hierarchy system.
123123

124-
## 🔧 Supported Languages
124+
## Supported Languages
125125

126126
The template supports CodeQL query development for:
127127

@@ -136,6 +136,14 @@ The template supports CodeQL query development for:
136136
| Python | `python` |
137137
| Ruby | `ruby` |
138138

139-
## 📄 License
139+
## License
140140

141141
This repository template is available under the [MIT License](LICENSE).
142+
143+
## Maintainers
144+
145+
This repository template is maintained by the [CODEOWNERS](CODEOWNERS).
146+
147+
## Support
148+
149+
This repository template comes with no expectation or guarantee of support, with more details in the [SUPPORT.md](SUPPORT.md) document.

SECURITY.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
Thanks for helping make GitHub safe for everyone.
2+
3+
# Security
4+
5+
GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations, such as [GitHub](https://github.com/GitHub).
6+
7+
Even though [open source repositories are outside of the scope of our bug bounty program](https://bounty.github.com/index.html#scope) and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
8+
9+
## Reporting Security Issues
10+
11+
If you believe you have found a security vulnerability in any GitHub-owned repository, please report it to us through coordinated disclosure.
12+
13+
**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
14+
15+
Instead, please send an email to opensource-security[@]github.com.
16+
17+
Please include as much of the information listed below as you can to help us better understand and resolve the issue:
18+
19+
- The type of issue (e.g., buffer overflow, SQL injection, or cross-site scripting)
20+
- Full paths of source file(s) related to the manifestation of the issue
21+
- The location of the affected source code (tag/branch/commit or direct URL)
22+
- Any special configuration required to reproduce the issue
23+
- Step-by-step instructions to reproduce the issue
24+
- Proof-of-concept or exploit code (if possible)
25+
- Impact of the issue, including how an attacker might exploit the issue
26+
27+
This information will help us triage your report more quickly.
28+
29+
## Policy
30+
31+
See [GitHub's Safe Harbor Policy](https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms)

SUPPORT.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# Support
2+
3+
## How to file issues and get help
4+
5+
This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new issue.
6+
7+
For help or questions about using this project, please create an issue.
8+
9+
- **THIS PROJECT NAME** is not actively developed but is maintained by GitHub staff **AND THE COMMUNITY**. We will do our best to respond to support and community questions in a timely manner.
10+
11+
## GitHub Support Policy
12+
13+
Support for this project is limited to the resources listed above.

0 commit comments

Comments
 (0)