Skip to content

Commit 5257d01

Browse files
F-ShahaliAHReccese
F-Shahali
and
AHReccese
authored
add standard documents (#18)
* update `AUTHORS.md` * update `CHANGELOG.md` * update `README.md` * add `RELEASE.md` * add standard fields to `package.json` * unused files removed * update discord url * add `.vscode` to `.gitignore` * update email address in `README.md` * change homepage in `package.json` * TOC removed, shields.io badges added * CNAME added * manifest.json updated * email updated * email updated * convert Markdown badges to pure html badges * change TS badge * fix the alignment [fixing height] --------- Co-authored-by: AHReccese <amirhssin6rst@gmail.com>
1 parent df56744 commit 5257d01

File tree

15 files changed

+125
-5440
lines changed

15 files changed

+125
-5440
lines changed

‎.github/CODE_OF_CONDUCT.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ representative at an online or offline event.
5858

5959
Instances of abusive, harassing, or otherwise unacceptable behavior may be
6060
reported to the community leaders responsible for enforcement at
61-
info@openscilab.com.
61+
mybutton@openscilab.com.
6262
All complaints will be reviewed and investigated promptly and fairly.
6363

6464
All community leaders are obligated to respect the privacy and security of the

‎.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
/node_modules
55
/.pnp
66
.pnp.js
7-
# yarn.lock
8-
7+
# vscode
8+
/.vscode
99
# testing
1010
/coverage
1111

‎.vscode/settings.json

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

‎AUTHORS.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Authors #
1+
# Authors
22

3-
----------
4-
- AmirHosein Rostami - Open Science Laboratory ([Github](https://github.com/AHReccese)) **
3+
---
54

5+
- AmirHosein Rostami - Open Science Laboratory ([Github](https://github.com/AHReccese))
6+
- Fatemeh Shahali ([Github](https://github.com/F-Shahali)) \*\*
67

7-
** **Maintainer**
8+
\*\* **Maintainer**
89

9-
# Other Contributors #
10-
----------
10+
# Other Contributors
11+
12+
---

‎CHANGELOG.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,20 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
56
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
67

78
## [Unreleased]
8-
## [0.1] - 202x-xx-xx
9+
10+
## [0.1] - 2024-xx-xx
11+
912
### Added
10-
- Item1
11-
- Item2
12-
- Item3
13-
### Changed
14-
- Item1
15-
- Item2
16-
- Item3
13+
14+
- `Email` support
15+
- `Gmail` support
16+
- `Telegram` support
17+
- Choose direct or indirect sharing mode
1718

1819
[Unreleased]: https://github.com/openscilab/mybutton/compare/v0.1...dev
19-
[0.1]: https://github.com/openscilab/mybutton/compare/c6df6cc...v0.1
20+
[0.1]: https://github.com/openscilab/mybutton/compare/c6df6cc...v0.1

‎README.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,49 @@
1-
# mybutton
1+
<div align="center">
2+
<a href="https://reactjs.org/">
3+
<img src="https://img.shields.io/badge/react-black?logo=react&style=for-the-badge" alt="React" style="height: 24px;">
4+
</a>
5+
<a href="https://www.typescriptlang.org/">
6+
<img src="https://shields.io/badge/TypeScript-3178C6?logo=TypeScript&logoColor=FFF&style=flat-square" alt="TypeScript" style="height: 24px;">
7+
</a>
8+
<a href="https://discord.gg/T2VzhzqU67">
9+
<img src="https://img.shields.io/discord/1064533716615049236.svg" alt="Discord Channel" style="height: 24px;">
10+
</a>
11+
</div>
12+
13+
## Overview
14+
MyButton is an open-source project that streamlines the process of sharing links to your preferred online services. It provides a user-friendly interface that allows users to seamlessly share content with just a few clicks. MyButton takes care of the technical aspects. Depending on the chosen service, it might:
15+
16+
- Redirect you directly to the platform with the link pre-populated.
17+
- Generate sharable buttons embedded with your link. Clicking these buttons redirects users to the chosen service.
18+
19+
## Supported services
20+
21+
| Service name | Support |
22+
| ------------ | -------- |
23+
| Email | &#x2705; |
24+
| Gmail | &#x2705; |
25+
| Telegram | &#x2705; |
26+
27+
## Issues & bug reports
28+
29+
Just fill an issue and describe it. We'll check it ASAP! or send an email to [mybutton@openscilab.com](mailto:mybutton@openscilab.com 'mybutton@openscilab.com').
30+
31+
- Please complete the issue template
32+
33+
You can also join our discord server
34+
35+
<a href="https://discord.gg/T2VzhzqU67">
36+
<img src="https://img.shields.io/discord/1064533716615049236.svg?style=for-the-badge" alt="Discord Channel">
37+
</a>
38+
39+
## Show Your Support
40+
41+
<h3>Star this repo</h3>
42+
43+
Give a ⭐️ if this project helped you!
44+
45+
<h3>Donate to our project</h3>
46+
47+
If you do like our project and we hope that you do, can you please support us? Our project is not and is never going to be working for profit. We need the money just so we can continue doing what we do ;-) .
48+
49+
<a href="https://openscilab.com/#donation" target="_blank"><img src="https://github.com/openscilab/mybutton/raw/main/otherfiles/donation.png" height="90px" width="270px" alt="mybutton Donation"></a>

‎otherfiles/RELEASE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# MyButton Release Instructions
2+
3+
#### Last Update: 2024-06-15
4+
5+
1. Create the `release` branch under `dev`
6+
2. Update all version tags
7+
1. `package.json`
8+
2. `README.md`
9+
3. Update `CHANGELOG.md`
10+
1. Add a new header under `Unreleased` section (Example: `## [0.1] - 2022-08-17`)
11+
2. Add a new compare link to the end of the file (Example: `[0.2]: https://github.com/openscilab/mybutton/compare/v0.1...v0.2`)
12+
3. Update `dev` compare link (Example: `[Unreleased]: https://github.com/openscilab/mybutton/compare/v0.2...dev`)
13+
4. Create a PR from `release` to `dev`
14+
1. Title: `Version x.x` (Example: `Version 0.1`)
15+
2. Tag all related issues
16+
3. Labels: `release`
17+
4. Set milestone
18+
5. Wait for all CI pass
19+
6. Need review (**2** reviewers)
20+
7. Squash and merge
21+
8. Delete `release` branch
22+
5. Merge `dev` branch into `main`
23+
1. `git checkout main`
24+
2. `git merge dev`
25+
3. `git push origin main`
26+
4. Wait for all CI pass
27+
6. Create a new release
28+
1. Target branch: `main`
29+
2. Tag: `vx.x` (Example: `v0.1`)
30+
3. Title: `Version x.x` (Example: `Version 0.1`)
31+
4. Copy changelogs
32+
5. Tag all related issues
33+
7. Bump!!
34+
8. Close this version issues
35+
9. Close milestone

‎otherfiles/donation.png

7.99 KB
Loading

‎package.json

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,20 @@
11
{
2-
"name": "react-ts",
2+
"name": "mybutton",
3+
"description": "Effortless link sharing across your desired platforms",
34
"version": "0.1.0",
4-
"private": true,
5+
"author": "MyButton Development Team",
6+
"license": "MIT",
7+
"homepage": "https://mybutton.click",
8+
"bugs": "https://github.com/openscilab/mybutton/issues",
9+
"keywords": [
10+
"url-sharing",
11+
"open-source",
12+
"link-sharing",
13+
"share-buttons",
14+
"web-development",
15+
"platform-integration",
16+
"social-media-sharing"
17+
],
518
"cracoConfig": "craco.config.js",
619
"dependencies": {
720
"@craco/craco": "^6.2.0",

‎public/CNAME

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

‎public/manifest.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
2-
"short_name": "<APP_SHORT_NAME>",
3-
"name": "<APP_NAME>",
2+
"short_name": "MyButton",
3+
"name": "MyButton",
44
"icons": [],
55
"start_url": ".",
66
"display": "standalone",

‎src/Components/ErrorBoundary/ErrorBoundary.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ export default class ErrorBoundary extends Component<EBProps> {
4141
Back to home
4242
{this.state.remainTime !== 0 ? ` (${this.state.remainTime}s)` : ''}
4343
</Button>
44-
<Button className='report-btn' href='mailto:info@openscilab.com'>
44+
<Button className='report-btn' href='mailto:mybutton@openscilab.com'>
4545
Report to OSL
4646
</Button>
4747
</div>

0 commit comments

Comments
 (0)