Skip to content

Commit e6218bd

Browse files
Small Changes
1 parent 36ce013 commit e6218bd

File tree

6 files changed

+111
-4
lines changed

6 files changed

+111
-4
lines changed

CHANGELOG.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,6 @@ All notable changes to the "html-snippets" extension will be documented in this
44

55
Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file.
66

7-
## [Unreleased]
7+
## v0.0.1 (2024-12-06)
88

9-
- Initial release
9+
Initial release with basic HTML5 boilerplate and common HTML tag snippets.

CONTRIBUTING.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
# Contributing to HTML Snippets for VS Code
2+
3+
Thank you for considering contributing to the **HTML Snippets** extension for Visual Studio Code! We appreciate your interest in improving the extension and making it more useful for developers.
4+
5+
## How Can I Contribute?
6+
7+
There are many ways you can contribute to this project:
8+
9+
1. **Bug Reports**: If you find a bug or issue with the extension, please open an issue on GitHub. Make sure to provide as much detail as possible, including steps to reproduce the issue.
10+
2. **Feature Requests**: If you'd like to see new features or additional snippets in the extension, open an issue with your suggestion, and we will review it.
11+
3. **Pull Requests**: You can submit your changes by forking the repository, creating a new branch, and submitting a pull request. We'll review your PR and merge it if it fits the project's goals.
12+
13+
## Prerequisites
14+
15+
To contribute to this project, you need the following:
16+
17+
- **Visual Studio Code**: The editor for which the extension is being developed.
18+
- **Node.js**: Make sure Node.js is installed on your machine. You can download it from [nodejs.org](https://nodejs.org/).
19+
- **Git**: You'll need Git to clone the repository and submit your changes.
20+
21+
22+
If you would like to add more snippets or improve the extension, feel free to fork the repository, make changes, and submit a pull request.
23+
24+
## Steps to Contribute:
25+
1. Fork the repository.
26+
2. Clone your fork:
27+
```bash
28+
git clone https://github.com/your-repo/html-snippets.git
29+
```
30+
3. Create a new branch:
31+
Before making any changes, create a new branch for your work. Be descriptive about the changes you're going to make.
32+
33+
```bash
34+
git checkout -b feature-name
35+
```
36+
4. Make your changes :
37+
Now, you can start making changes to the code. You can:
38+
39+
- Add new HTML snippets.
40+
- Modify existing snippets.
41+
- Update documentation like the README.md or add new sections for future features.
42+
43+
5. Test the Extension
44+
After making your changes, test the extension locally by running it in VS Code:
45+
46+
Press F5 in VS Code to open a new window with your extension loaded.
47+
In the new window, open an HTML file and test the snippets you've added or modified.
48+
49+
6. Commit your changes:
50+
```bash
51+
git commit -m "Added new snippets"
52+
```
53+
7. Push to your fork:
54+
```bash
55+
git push origin feature-name
56+
```
57+
58+
8. Open a Pull Request
59+
Go to your forked repository on GitHub and click Compare & Pull Request.
60+
61+
Provide a clear description of what you've changed and why. If you're fixing a bug, mention the issue number.
62+
63+
9. Code Review
64+
Once your pull request is submitted, the project maintainers will review your changes. If necessary, they will suggest modifications. After the review process, your changes will be merged into the main branch.
65+
66+
67+
## Code Style
68+
69+
1. Make sure your code is well-formatted and follows consistent style.
70+
2. Please add appropriate comments where needed, especially for complex code.
71+
3. Ensure your code doesn't break existing features by thoroughly testing it.
72+
73+
## Reporting Issues
74+
If you encounter any problems or bugs while using the extension, please report them on the GitHub Issues page. Include the following information:
75+
1. A detailed description of the issue.
76+
2. Steps to reproduce the issue.
77+
3. The environment (VS Code version, OS, etc.).
78+
4. Screenshots, if applicable.
79+
80+
Thank you for helping to make the Advanced HTML Snippets extension better! If you have any questions or need help, feel free to ask on the GitHub Discussions page.

README.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,3 +48,30 @@ Once installed, you can use the following snippets by typing their prefix and hi
4848
/blob/main/images/code.png" width="600" alt="basic html snippets">
4949

5050

51+
## How to Contribute
52+
We welcome contributions to this extension! If you would like to add more snippets or improve the extension, feel free to fork the repository, make changes, and submit a pull request.
53+
54+
## Steps to Contribute:
55+
1. Fork the repository.
56+
2. Clone your fork:
57+
```bash
58+
git clone https://github.com/your-repo/html-snippets.git
59+
```
60+
3.Create a new branch:
61+
```bash
62+
git checkout -b feature-name
63+
```
64+
4. Make your changes (e.g., add new snippets).
65+
5. Commit your changes:
66+
```bash
67+
git commit -m "Added new snippets"
68+
```
69+
6. Push to your fork:
70+
```bash
71+
git push origin feature-name
72+
```
73+
Open a pull request on the original repository.
74+
75+
## License
76+
This project is licensed under the **[MIT license](https://opensource.org/licenses/MIT)**. See the LICENSE file for details.
77+

images/code.png

179 KB
Loading

images/logos.png

34.7 KB
Loading

snippets/html.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"doctype": {
3-
"prefix": "doctype",
3+
"prefix": "!!!",
44
"body": [
5-
"<!DOCTYPE>",
5+
"<!DOCTYPE html>",
66
"$1"
77
],
88
"description": "HTML - Defines the document type"

0 commit comments

Comments
 (0)