Skip to content

Commit 1da20c9

Browse files
ProskyneteProskynete
authored
Merge pull request #51 from Proskynete/dev
New version! 💪🏻
2 parents 492389a + a14ec93 commit 1da20c9

File tree

127 files changed

+11909
-6766
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

127 files changed

+11909
-6766
lines changed

‎.eslintignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
lib

‎.eslintrc.js‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
module.exports = {
2+
root: true,
3+
env: {
4+
es2020: true,
5+
node: true,
6+
jest: true,
7+
},
8+
extends: [
9+
'eslint:recommended',
10+
'plugin:@typescript-eslint/recommended',
11+
'plugin:prettier/recommended',
12+
'plugin:jest/recommended',
13+
'plugin:testing-library/dom',
14+
],
15+
ignorePatterns: ['./lib'],
16+
plugins: ['@typescript-eslint', 'jest', 'testing-library'],
17+
parser: '@typescript-eslint/parser',
18+
rules: {
19+
'no-console': 0,
20+
'@typescript-eslint/no-explicit-any': 0,
21+
'no-underscore-dangle': 0,
22+
'@typescript-eslint/naming-convention': 0,
23+
},
24+
};

‎.eslintrc.json‎

Lines changed: 0 additions & 119 deletions
This file was deleted.

‎.github/CONTRIBUTING.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# Contributing to Vertical Timeline Component for React
2+
3+
Do you want to help me maintain this project? **Here's how you can help.**
4+
Please take a moment to review this document to make the contribution process easy and effective for everyone 💖
5+
6+
## Feature requests
7+
8+
Feature requests are welcome. But take a moment to find out whether your idea fits with the scope and aims of the project. It's up to _you_ to make a strong case to convince me of the merits of this feature. Please provide as much detail and context as possible.
9+
10+
## Pull requests
11+
12+
Good pull requests, such as patches, improvements, and new features, are a fantastic help. They should remain focused in scope and avoid containing unrelated commits. If your contribution involves a significant amount of work or substantial changes to any part of the project, please open an issue to discuss it first. This will help ensure that your precious work is not in vain. Please ask first before embarking on any significant pull request (e.g. implementing features, refactoring code, porting to a different language). I'm happy to discuss your ideas.
13+
14+
## Code guidelines
15+
16+
- **Code style**: I use [Prettier](https://prettier.io/) to format my code. Please use it too.
17+
- **Tests**: I use [Jest](https://jestjs.io/) to test my code. Please write tests for your code.
18+
19+
Run npm run test before committing to ensure your changes follow our coding standards.
20+
21+
## Commit guidelines
22+
23+
- **Commit message format**: I use [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) to format my commit messages. Please use it too.
24+
25+
## License
26+
27+
By contributing your code, you agree to license your contribution under the [MIT license](https://github.com/Proskynete/vertical-timeline-component-react/blob/master/LICENSE).

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
name: Report a bug
2+
description: Tell us about a bug or issue you may have identified in this library.
3+
title: 'Provide a general summary of the issue'
4+
labels: [bug]
5+
body:
6+
- type: checkboxes
7+
attributes:
8+
label: Prerequisites
9+
description: Please take a couple of minutes to help me work faster.
10+
options:
11+
- label: I have read the [contributing guidelines](https://github.com/Proskynete/vertical-timeline-component-react/blob/master/.github/CONTRIBUTING.md)
12+
required: true
13+
- type: textarea
14+
id: what-happened
15+
attributes:
16+
label: Describe the issue
17+
description: Provide a summary of the issue and what you expected to happen, including specific steps to reproduce.
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: reduced-test-case
22+
attributes:
23+
label: Reduced test cases
24+
description: Include links [reduced test case](https://css-tricks.com/reduced-test-cases/) links or suggested fixes using CodePen ([v4 template](https://codepen.io/team/bootstrap/pen/yLabNQL) or [v5 template](https://codepen.io/team/bootstrap/pen/qBamdLj)).
25+
validations:
26+
required: true
27+
- type: dropdown
28+
id: os
29+
attributes:
30+
label: What operating system(s) are you seeing the problem on?
31+
multiple: true
32+
options:
33+
- Windows
34+
- macOS
35+
- Android
36+
- iOS
37+
- Linux
38+
validations:
39+
required: true
40+
- type: dropdown
41+
id: browser
42+
attributes:
43+
label: What browser(s) are you seeing the problem on?
44+
multiple: true
45+
options:
46+
- Chrome
47+
- Safari
48+
- Firefox
49+
- Microsoft Edge
50+
- Opera
51+
- type: input
52+
id: version
53+
attributes:
54+
label: What version of this library are you using?
55+
placeholder: 'e.g., v3.0.4 or v2.1.2'
56+
validations:
57+
required: true

‎.github/funding.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
github: Proskynete
2+
custom: https://thanks.eduardoalvarez.dev/donate

‎.github/pull_request_template.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Description
2+
3+
Please include a summary of the changes and the related issue. 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+
- [ ] Other (If yes, please write one phrase about this update)
16+
17+
# How Has This Been Tested?
18+
19+
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
20+
21+
- [ ] Test A
22+
- [ ] Test B
23+
24+
# Checklist
25+
26+
- [ ] My code follows the style guidelines of this project
27+
- [ ] I have performed a self-review of my code
28+
- [ ] I have commented my code, particularly in hard-to-understand areas
29+
- [ ] I have made corresponding changes to the documentation
30+
- [ ] My changes generate no new warnings
31+
- [ ] I have added tests that prove my fix is effective or that my feature works
32+
- [ ] New and existing unit tests pass locally with my changes
33+
- [ ] Any dependent changes have been merged and published in downstream modules

‎.github/workflow/publish.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: '🚀 Publish'
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
jobs:
9+
publish:
10+
name: '🚀 Publish'
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: '📚 Checkout'
14+
uses: actions/[email protected]
15+
- name: '🟢 Setup Node.js'
16+
uses: actions/[email protected]
17+
with:
18+
node-version: 14
19+
- name: '🚀 Publish'
20+
run: npm publish --access public
21+
env:
22+
NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}

‎.husky/pre-commit‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
#!/usr/bin/env sh
2+
. "$(dirname -- "$0")/_/husky.sh"
3+
4+
npm run lint && npm run build

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v14

0 commit comments

Comments
 (0)