Skip to content

Commit 7254742

Browse files
mr-emamr-ema
committed
Initial Commit
0 parents  commit 7254742

40 files changed

+3866
-0
lines changed

‎.editorconfig

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Editor configuration, see https://editorconfig.org
2+
root = true
3+
4+
[*]
5+
charset = utf-8
6+
indent_style = space
7+
insert_final_newline = true
8+
trim_trailing_whitespace = true
9+
10+
[*.{css,html,shtml,json}]
11+
indent_size = 2
12+
quote_type = double
13+
14+
[*.{js,ts}]
15+
indent_size = 4
16+
quote_type = single
17+
18+
[*.md]
19+
max_line_length = off
20+
trim_trailing_whitespace = false

‎.github/CONTRIBUTING.md

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to OnePageJS
2+
Thank you for considering contributing to OnePageJS! We appreciate your
3+
help in making this project better. Whether you are fixing a bug, adding
4+
a feature, or improving the documentation, your contribution is valuable.
5+
6+
## How to Contribute
7+
8+
### Reporting Bugs
9+
If you find a bug, please open an issue using the appropriate
10+
template. Provide as much detail as possible, including steps to
11+
reproduce, the environment, and any error messages.
12+
13+
### Suggesting Features
14+
If you'd like to suggest a new feature or improvement, feel free to open
15+
an issue to discuss it. Please provide detailed reasoning and possible
16+
use cases to justify the request.
17+
18+
### Submitting Code
19+
To submit code, please fork the repository and create a new branch. Make sure your code adheres to the following:
20+
- Follow the coding style of the project
21+
- Add unit tests for any new functionality.
22+
- Ensure that all existing tests pass.
23+
- Write clear, concise commit messages.
24+
25+
Once your changes are ready, submit a pull request to the dev
26+
branch. Include a detailed description of your changes and reference
27+
any related issues.
28+
29+
### Code of Conduct
30+
By contributing to this project, you agree to adhere to the following principles:
31+
32+
- Respect: Treat everyone with kindness and respect, regardless of their background, experience, or perspective.
33+
- Collaboration: Foster a welcoming and inclusive environment where everyone feels encouraged to contribute.
34+
- Constructive Communication: Engage in discussions with courtesy and an open mind, promoting healthy and respectful debate.
35+
- Integrity: Uphold honesty and transparency in all contributions and communications.
36+
37+
Please be mindful that this project is a space for all, and we ask that
38+
you treat others with the same dignity and understanding that you would
39+
expect for yourself.
40+
41+
## Development Setup
42+
To get started with development, you’ll need to install
43+
[Bun](https://bun.sh/). Bun is used for bundling, running tests, and
44+
serving the project locally.
45+
46+
Run the following commands to set up the project:
47+
```bash
48+
git clone https://github.com/mr-ema/onepage-js
49+
bun install
50+
```
51+
52+
Thank you for your contributions!

‎.github/ISSUE_TEMPLATE/BUG-REPORT.yml

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
name: "🐛 Bug Report"
2+
description: Create a new ticket for a bug.
3+
title: "🐛 [BUG] - <title>"
4+
labels: [
5+
"bug"
6+
]
7+
body:
8+
- type: textarea
9+
id: description
10+
attributes:
11+
label: "Description"
12+
description: Please enter an explicit description of your issue
13+
placeholder: Short and explicit description of your incident...
14+
validations:
15+
required: true
16+
- type: input
17+
id: reprod-url
18+
attributes:
19+
label: "Reproduction URL"
20+
description: Please enter your GitHub URL to provide a reproduction of the issue
21+
placeholder: ex. https://github.com/USERNAME/REPO-NAME
22+
validations:
23+
required: true
24+
- type: textarea
25+
id: reprod
26+
attributes:
27+
label: "Reproduction steps"
28+
description: Please enter an explicit description of your issue
29+
value: |
30+
1. Go to '...'
31+
2. Click on '....'
32+
3. Scroll down to '....'
33+
4. See error
34+
render: bash
35+
validations:
36+
required: true
37+
- type: textarea
38+
id: screenshot
39+
attributes:
40+
label: "Screenshots"
41+
description: If applicable, add screenshots to help explain your problem.
42+
value: |
43+
![DESCRIPTION](LINK.png)
44+
render: bash
45+
validations:
46+
required: false
47+
- type: textarea
48+
id: logs
49+
attributes:
50+
label: "Logs"
51+
description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
52+
render: bash
53+
validations:
54+
required: false
55+
- type: dropdown
56+
id: browsers
57+
attributes:
58+
label: "Browsers"
59+
description: What browsers are you seeing the problem on ?
60+
multiple: true
61+
options:
62+
- Firefox
63+
- Chrome
64+
- Safari
65+
- Microsoft Edge
66+
- Opera
67+
validations:
68+
required: false
69+
- type: dropdown
70+
id: os
71+
attributes:
72+
label: "OS"
73+
description: What is the impacted environment ?
74+
multiple: true
75+
options:
76+
- Windows
77+
- Linux
78+
- Mac
79+
validations:
80+
required: false

‎.github/ISSUE_TEMPLATE/FEATURE-REQUEST.yml

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: "💡 Feature Request"
2+
description: Create a new ticket for a new feature request
3+
title: "💡 [REQUEST] - <title>"
4+
labels: [
5+
"question"
6+
]
7+
body:
8+
- type: input
9+
id: start_date
10+
attributes:
11+
label: "Start Date"
12+
description: Start of development
13+
placeholder: "month/day/year"
14+
validations:
15+
required: false
16+
- type: textarea
17+
id: implementation_pr
18+
attributes:
19+
label: "Implementation PR"
20+
description: Pull request used
21+
placeholder: "#Pull Request ID"
22+
validations:
23+
required: false
24+
- type: textarea
25+
id: reference_issues
26+
attributes:
27+
label: "Reference Issues"
28+
description: Common issues
29+
placeholder: "#Issues IDs"
30+
validations:
31+
required: false
32+
- type: textarea
33+
id: summary
34+
attributes:
35+
label: "Summary"
36+
description: Provide a brief explanation of the feature
37+
placeholder: Describe in a few lines your feature request
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: basic_example
42+
attributes:
43+
label: "Basic Example"
44+
description: Indicate here some basic examples of your feature.
45+
placeholder: A few specific words about your feature request.
46+
validations:
47+
required: true
48+
- type: textarea
49+
id: drawbacks
50+
attributes:
51+
label: "Drawbacks"
52+
description: What are the drawbacks/impacts of your feature request ?
53+
placeholder: Identify the drawbacks and impacts while being neutral on your feature request
54+
validations:
55+
required: true
56+
- type: textarea
57+
id: unresolved_question
58+
attributes:
59+
label: "Unresolved questions"
60+
description: What questions still remain unresolved ?
61+
placeholder: Identify any unresolved issues.
62+
validations:
63+
required: false

‎.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: false

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Pull Request for OnePageJS
2+
3+
## Description
4+
Please include a summary of the changes you have made and the issue(s)
5+
this PR addresses. Include relevant screenshots or references to issues
6+
if applicable.
7+
8+
### Changes
9+
- List the changes made in the codebase, including any new features or bug fixes.
10+
- Provide any relevant details about the implementation (e.g., how it integrates with existing features).
11+
12+
## Type of Change
13+
- [ ] Bug fix
14+
- [ ] New feature
15+
- [ ] Documentation update
16+
- [ ] Code quality improvements
17+
- [ ] Other (please describe):
18+
19+
## Checklist
20+
- [ ] I have read the contributing guidelines and followed the code of conduct.
21+
- [ ] My code follows the project’s coding style.
22+
- [ ] I have tested my changes locally.
23+
- [ ] I have updated the documentation (if necessary).
24+
- [ ] I have added tests to cover my changes (if applicable).
25+
26+
## Related Issue(s)
27+
- Closes # (issue number)
28+
- Fixes # (issue number)
29+
30+
## Additional Information
31+
Please include any additional information that may help the reviewers (e.g., testing environment, specific configuration details, etc.).

‎.github/workflows/ci.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: CI Workflow
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
- dev
8+
9+
pull_request:
10+
branches:
11+
- dev
12+
13+
jobs:
14+
test_and_build:
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
- name: Checkout the code
19+
uses: actions/checkout@v4
20+
21+
- name: Set up Bun
22+
uses: oven-sh/setup-bun@v2
23+
24+
- name: Install dependencies
25+
run: bun install
26+
27+
- name: Run tests
28+
run: bun run test
29+
30+
- name: Build the project
31+
run: bun run build
32+
if: success()

0 commit comments

Comments
 (0)