Skip to content

Commit da08c9f

Browse files
aadhar41aadhar41
committed
feat: initialize project with governance documents, contribution guidelines, and GitHub templates.
1 parent 69b3617 commit da08c9f

9 files changed

Lines changed: 242 additions & 9 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

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

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

‎.github/pull_request_template.md‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Description
2+
3+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
Please delete options that are not relevant.
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
## How Has This Been Tested?
17+
18+
Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
## Checklist
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my own code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules

‎.gitignore‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2-
31
# dependencies
42
/node_modules
53
/.pnp
@@ -21,3 +19,15 @@
2119
npm-debug.log*
2220
yarn-debug.log*
2321
yarn-error.log*
22+
23+
# IDEs and editors
24+
.vscode/
25+
.idea/
26+
*.swp
27+
*.swo
28+
*.sublime-project
29+
*.sublime-workspace
30+
31+
# OS
32+
Thumbs.db
33+
Desktop.ini

‎CHANGELOG.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
## [1.1.0] - 2026-02-01
6+
7+
### Added
8+
9+
- Professional repository setup with LICENSE, CONTRIBUTING.md, and CODE_OF_CONDUCT.md.
10+
- GitHub Issue and Pull Request templates.
11+
- Complete README update to accurately reflect the tech stack (React-Markdown, React-To-Print, Remark-GFM).
12+
- Real-time Markdown rendering with live preview.
13+
- Support for GitHub Flavored Markdown (GFM).
14+
- Print-to-PDF functionality for generated Markdown previews.
15+
- Improved project structure and .gitignore configuration.

‎CODE_OF_CONDUCT.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
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, sex characteristics, gender identity and
9+
expression, level of experience, education, socio-economic status, nationality,
10+
personal appearance, race, religion, or sexual identity and 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+
## Our Responsibilities
24+
25+
Project maintainers are responsible for clarifying the standards of acceptable
26+
behavior and are expected to take appropriate and fair corrective action in
27+
response to any instances of unacceptable behavior.
28+
29+
## attribution
30+
31+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
32+
version 1.4, available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
33+
34+
[homepage]: https://www.contributor-covenant.org
35+
36+
For answers to common questions about this code of conduct, see
37+
<https://www.contributor-covenant.org/faq>

‎CONTRIBUTING.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing to Markdown Previewer
2+
3+
First off, thanks for taking the time to contribute! 🎉
4+
5+
The following is a set of guidelines for contributing to the Markdown Previewer project.
6+
7+
## How Can I Contribute?
8+
9+
### Reporting Bugs
10+
11+
If you find a bug, please create an issue with:
12+
13+
- A clear and descriptive title.
14+
- Steps to reproduce the bug.
15+
- A description of the expected and actual behavior.
16+
- Any relevant screenshots or logs.
17+
18+
### Feature Requests
19+
20+
If you have an idea for a new feature, feel free to open an issue to discuss it.
21+
22+
### Pull Requests
23+
24+
- Fork the repository.
25+
- Create a new branch for your feature or bug fix.
26+
- Make your changes.
27+
- Ensure the code follows the existing style.
28+
- Submit a pull request.
29+
30+
## Style Guide
31+
32+
- Use consistent indentation (2 spaces).
33+
- Write clean, readable code.
34+
- Comment complex logic where necessary.
35+
36+
Thank you!

‎LICENSE‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2026 Aadhar Gaur
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -46,13 +46,6 @@ A simple and efficient React-based web application that allows users to write Ma
4646

4747
The application will be available at `http://localhost:3000`.
4848

49-
## Technologies Used
50-
51-
- **React**: Frontend library for building the user interface.
52-
- **Marked**: A low-level markdown compiler for parsing markdown.
53-
- **DOMPurify**: To sanitize the HTML output and prevent XSS attacks.
54-
- **CSS3**: For custom styling and layout.
55-
5649
## Project Structure
5750

5851
```text
@@ -65,3 +58,23 @@ markdown-preview/
6558
│ └── index.js # Entry point
6659
└── README.md
6760
```
61+
62+
## Contributing
63+
64+
Contributions are welcome! Please read [CONTRIBUTING.md](CONTRIBUTING.md) for more details.
65+
66+
## License
67+
68+
Distributed under the MIT License. See `LICENSE` for more information.
69+
70+
## Author
71+
72+
**Aadhar Gaur**
73+
74+
- **GitHub**: [@aadhar41](https://github.com/aadhar41)
75+
- **LinkedIn**: [aadhar-gaur-php](https://linkedin.com/in/aadhar-gaur-php)
76+
77+
## Acknowledgments
78+
79+
- [React Markdown](https://github.com/remarkjs/react-markdown) for the core rendering logic.
80+
- Built with ❤️ by Aadhar Gaur.

0 commit comments

Comments
 (0)