Skip to content

Commit 0e350dd

Browse files
committed
Add basic project description and template
1 parent af8b68d commit 0e350dd

File tree

11 files changed

+430
-5
lines changed

11 files changed

+430
-5
lines changed

.github/FUNDING.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# These are supported funding model platforms
2+
3+
github: AI-QL
4+
custom: ["https://www.aiql.com"]
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: 'Bug report'
2+
description: Report a bug in this project.
3+
labels: ['bug']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating an issue, please read the following:
9+
10+
- Read the `README.md` file on the project page or the documentation file and compare your code to the intent of the project.
11+
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
12+
- Please create a separate issue for each type of issue.
13+
- For modular projects, make sure you're using the latest version of the module.
14+
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
15+
- type: textarea
16+
attributes:
17+
label: Describe the bug
18+
description: |
19+
For the issue you are experiencing, please describe in detail what you are seeing, the error message, and the impact of the issue. If you are able to reproduce the issue, please list the steps in order. You can attach an image or video if necessary.
20+
validations:
21+
required: true
22+
- type: textarea
23+
attributes:
24+
label: Expected behavior
25+
description: Describe how it should be handled when it's normal behavior or what needs to be fixed.
26+
validations:
27+
- type: input
28+
attributes:
29+
label: Your environment - System OS
30+
description: Please describe the full range of OSes you are experiencing the issue with, preferably including the version.
31+
placeholder: Windows 11, macOS 15.x, Linux Ubuntu 24.04...
32+
validations:
33+
- type: input
34+
attributes:
35+
label: Your environment - Node.js
36+
description: If relevant, please describe the version of Node.js you are currently using.
37+
placeholder: 20.19.4, 22.17.0, 24.4.0...
38+
validations:

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Feature request'
2+
description: Report a feature request in this project.
3+
labels: ['enhancement']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating an issue, please read the following:
9+
10+
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
11+
- Please create a separate issue for each type of issue.
12+
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
13+
- type: textarea
14+
attributes:
15+
label: Describe the feature
16+
description: Feel free to describe any features or improvements you would like to see. You can attach text or images of examples, behavior, etc. from other projects to elaborate.
17+
validations:
18+
required: true
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: 'Fix typo request'
2+
description: Request to fix a typo or bad translation in this project
3+
labels: ['typo']
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Before creating an issue, please read the following:
9+
10+
- Search to see if the same issue already exists, and keep the title concise and accurate so that it's easy for others to understand and search for.
11+
- Please create a separate issue for each type of issue.
12+
- Please be as detailed as possible and write in English so that we can handle your issue quickly.
13+
- type: textarea
14+
attributes:
15+
label: Describe the issue
16+
description: Please describe where the typo occurs and a list of text that needs to be corrected.
17+
validations:
18+
required: true

.github/pull_request_template.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
Thank you for contributing to the project. Your contribution will be reviewed and approved after appropriate review.
3+
4+
Please read the caveats below to ensure a fast merge.
5+
-->
6+
7+
## Pull request checklist
8+
9+
You should familiarize yourself with the files `README.md`, `CONTRIBUTING.md`, and `CODE_OF_CONDUCT.md` in the root of your project.
10+
11+
- If an issue has been created for this, add `(fixes #{ISSUE_NUMBER})` to the end of the commit description. In `{ISSUE_NUMBER}`, please include the relevant issue number.
12+
- If you need to update or add to the article, please update the relevant content. If a multilingual article exists, you should update all relevant content in your own language, except for translations.
13+
- Add or update test code if it exists and is needed. Also, verify that the tests pass.
14+
- If this PR is not yet complete, keep the PR in draft status. If it's no longer valid, close the PR with an explanation.
15+
16+
<!--
17+
Below is a template for describing this PR. It's not required, so please delete the content below if you don't need it.
18+
-->
19+
20+
### What did you change?
21+
22+
### Why did you make the change?
23+
24+
### How does this work?

.github/workflows/build-test.yml

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Build Test
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- '**'
8+
- '!LICENSE'
9+
- '!*.md'
10+
- '!docs/**'
11+
- '!.github/**'
12+
- '.github/workflows/build-test.yml'
13+
pull_request:
14+
branches: [main]
15+
workflow_dispatch:
16+
17+
jobs:
18+
build-test:
19+
runs-on: ${{ matrix.os }}
20+
name: Test Node.js ${{ matrix.node_version }} on ${{ matrix.os }}
21+
strategy:
22+
fail-fast: false
23+
matrix:
24+
node_version: ['20', '22']
25+
os: [windows-latest, macos-latest, ubuntu-latest]
26+
27+
steps:
28+
- uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0
31+
32+
- name: Setup Node.js ${{ matrix.node_version }}
33+
uses: actions/setup-node@v4
34+
with:
35+
node-version: ${{ matrix.node_version }}
36+
cache: npm
37+
cache-dependency-path: '**/package-lock.json'
38+
39+
- name: Cache dependencies
40+
uses: actions/cache@v4
41+
id: npm-cache
42+
with:
43+
path: |
44+
**/node_modules
45+
key: ${{ runner.os }}-npm-${{ hashFiles('**/package-lock.json') }}
46+
restore-keys: |
47+
${{ runner.os }}-npm-
48+
49+
- name: Install dependencies
50+
if: steps.npm-cache.outputs.cache-hit != 'true'
51+
run: npm i
52+
53+
- name: Test module script
54+
run: |
55+
npm run build

CODE_OF_CONDUCT.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
6+
7+
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
8+
9+
## Our Standards
10+
11+
Examples of behavior that contributes to a positive environment for our community include:
12+
13+
- Demonstrating empathy and kindness toward other people
14+
- Being respectful of differing opinions, viewpoints, and experiences
15+
- Giving and gracefully accepting constructive feedback
16+
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
17+
- Focusing on what is best not just for us as individuals, but for the overall community
18+
19+
Examples of unacceptable behavior include:
20+
21+
- The use of sexualized language or imagery, and sexual attention or advances of any kind
22+
- Trolling, insulting or derogatory comments, and personal or political attacks
23+
- Public or private harassment
24+
- Publishing others' private information, such as a physical or email address, without their explicit permission
25+
- Other conduct which could reasonably be considered inappropriate in a professional setting
26+
27+
## Enforcement Responsibilities
28+
29+
Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
30+
31+
Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
32+
33+
## Scope
34+
35+
This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
36+
37+
## Enforcement
38+
39+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at https://www.aiql.com. All complaints will be reviewed and investigated promptly and fairly.
40+
41+
All community leaders are obligated to respect the privacy and security of the reporter of any incident.
42+
43+
## Enforcement Guidelines
44+
45+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
46+
47+
### 1. Correction
48+
49+
**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
50+
51+
**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
52+
53+
### 2. Warning
54+
55+
**Community Impact**: A violation through a single incident or series of actions.
56+
57+
**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
58+
59+
### 3. Temporary Ban
60+
61+
**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
62+
63+
**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
64+
65+
### 4. Permanent Ban
66+
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
68+
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
70+
71+
## Attribution
72+
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
74+
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
76+
77+
[homepage]: https://www.contributor-covenant.org
78+
79+
For answers to common questions about this code of conduct, see the FAQ at https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Contributing to Project
2+
3+
Thank you for contributing to the project. Your contributions will help us take the project to the next level.
4+
5+
This project adheres to the Contributor Covenant code of conduct. Your contribution implies that you have read and agree to this policy. Any behavior that undermines the quality of the project community, including this policy, will be warned or restricted by the maintainers.
6+
7+
## Issues
8+
9+
Issues can be created on the following page: https://github.com/AI-QL/mcp-devcontainers/issues
10+
11+
Alternatively, you can email the package maintainer. However, we prefer to track progress via GitHub Issues.
12+
13+
When creating an issue, keep the following in mind:
14+
15+
- Please specify the correct category selection based on the format of the issue (e.g., bug report, feature request).
16+
- Check to see if there are duplicate issues.
17+
- Describe in detail what is happening and what needs to be fixed. You may need additional materials such as images or video.
18+
- Use appropriate keyword titles to make it easy for others to search and understand.
19+
- Please use English in all content.
20+
- You may need to describe the environment in which the issue occurs.
21+
22+
## How to contribute (Pull Requests)
23+
24+
### Write the code you want to change
25+
26+
Here's the process for contributing to the project:
27+
28+
1. Clone the project (or rebase to the latest commit in the main branch)
29+
2. Install the package (if the package manager exists)
30+
3. Setting up lint or code formatter in the IDE (if your project includes a linter) and installing the relevant plugins. Some projects may use specific commands to check rules and perform formatting after module installation and before committing.
31+
4. Write the code that needs to be fixed
32+
5. Update the documentation (if it exists) or create a new one. If your project supports multilingual documentation, update the documentation for all languages. You can fill in the content in your own language and not translate it.
33+
6. Add or modify tests as needed (if test code exists). You should also verify that existing tests pass.
34+
35+
### Write a commit message
36+
37+
While we don't have strict restrictions on commit messages, we recommend that you follow the recommendations below whenever possible:
38+
39+
- Write in English.
40+
- Use the ` symbol to name functions, variables, or folders and files.
41+
- Use a format like `xxx: message (fixes #1)`. The content in parentheses is optional.
42+
- The message includes a summary of what was modified.
43+
- It's a good idea to separate multiple modifications into their own commit messages.
44+
45+
It is recommended that you include a tag at the beginning of the commit message. Between the tag and the message, use `: ` between the tag and the message.
46+
47+
tags conform to the ["Udacity Git Commit Message Style Guide"](https://udacity.github.io/git-styleguide). However, you are welcome to use tags not listed here for additional situations.
48+
49+
- `feat`: A new feature
50+
- `fix`: A bug fix
51+
- `docs`: Changes to documentation
52+
- `style`: Formatting, missing semicolons, etc.; no code change
53+
- `refactor`: Refactoring production code
54+
- `test`: Adding tests, refactoring test; no production code change
55+
- `chore`: Updating build tasks, package manager configs, etc.; no production code change
56+
57+
Informal tags:
58+
59+
- `package`: Modifications to package settings, modules, or GitHub projects
60+
- `typo`: Fix typos
61+
62+
### Create a pull request
63+
64+
When creating a pull request, keep the following in mind:
65+
66+
- Include a specific description of what the modification is, why it needs to be made, and how it works.
67+
- Check to see if there are duplicate pull requests.
68+
- Please use English in all content.
69+
70+
Typically, a project maintainer will review and test your code before merging it into the project. This process can take some time, and they may ask you for further edits or clarifications in the comments.
71+
72+
## Development Guide
73+
74+
### Prerequisites
75+
76+
The following software is required to work on the spec:
77+
78+
- Node.js 20 or above
79+
- TypeScript
80+
81+
## Getting Started
82+
83+
1. Fork the repository
84+
2. Clone your fork:
85+
86+
```bash
87+
git clone https://github.com/YOUR-USERNAME/mcp-devcontainers.git
88+
cd mcp-devcontainers
89+
```
90+
91+
3. Install dependencies:
92+
93+
```bash
94+
npm install # install dependencies
95+
```
96+
97+
## Making Changes
98+
99+
1. Create a new branch:
100+
101+
```bash
102+
git checkout -b feature/your-feature-name
103+
```
104+
105+
2. Make your changes
106+
3. Lint your changes:
107+
108+
```bash
109+
npm run lint:fix # perform lint validation/fixing
110+
```
111+
112+
4. Run build locally:
113+
114+
```bash
115+
npm run build
116+
```
117+
118+
5. Test MCP servers:
119+
120+
```bash
121+
npm run start
122+
```

0 commit comments

Comments
 (0)