Skip to content

Commit 1a33f06

Browse files
babblebeybabblebey
authored
chore: going open source (#63)
This Pull request fulfils tasks required to take jargons.dev repo open source. ### Changes Made - Wrote the project Code of Conduct - Wrote the project Contribution Guide - Updated Project Licence to "GNU GENERAL PUBLIC LICENSE V2" - Added the Pull Request Template - Added the Issue template - Added bug report template - Added Feature request template - Configured a template chooser - Added the `.vercel` folder to `.gitignore` to avoid pushing build file to repo - Added project README - Implemented the `dev/setup` script which help streamline creation of the `jargons.dev-app` for user's testing, create a user's own `.env` file and provides instruction on how to setup a test repo for development purposes - Added a new script `setup` to `package.json` to allow user run the `dev/setup` script on execution of `npm run setup` command - Added a README to the script directory to provide more context into script's specific operations - Implemented a coming soon page, with a temporary redirect from the homepage - this is just temporary 😉 ### Related Issue Related to #55 ### Screencast/Screenshot _**Coming soon page**_ ![image](https://github.com/babblebey/jargons.dev/assets/25631971/5c0633b0-bfd2-429d-ab26-8f569618f7a8) 📖
2 parents 159ddd0 + fc2ef45 commit 1a33f06

19 files changed

Lines changed: 1369 additions & 76 deletions

‎.env.example‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@ GITHUB_APP_ID=
33
# IMPORTANT: private keys must be in PKCS#8 format, see https://github.com/gr2m/universal-github-app-jwt/#about-private-key-formats
44
GITHUB_APP_PRIVATE_KEY="-----BEGIN PRIVATE KEY-----\nMII...und==\n-----END PRIVATE KEY-----\n"
55

6-
GITHUB_OAUTH_APP_CLIENT_ID=""
7-
GITHUB_OAUTH_APP_CLIENT_SECRET=""
6+
GITHUB_OAUTH_APP_CLIENT_ID="cd1a167a7112b779202b"
7+
GITHUB_OAUTH_APP_CLIENT_SECRET="72efcd4eac54cd7d53d9f6a8dcc20cd2c3a464cf"
88

99
CRYPTO_SECRET_KEY="secret"
1010

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: 🐛 Bug Report
2+
description: Create a report to help us improve
3+
title: "[BUG]: "
4+
labels: ["🐛 Bug"]
5+
body:
6+
- type: checkboxes
7+
id: duplicates
8+
attributes:
9+
label: Has this bug been raised before?
10+
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
11+
options:
12+
- label: I have checked "open" AND "closed" issues and this is not a duplicate
13+
required: true
14+
- type: textarea
15+
id: description
16+
attributes:
17+
label: Description
18+
description: A clear description of the bug you have found. Please include relevant information and resources (for example the steps to reproduce the bug)
19+
validations:
20+
required: true
21+
- type: textarea
22+
id: steps
23+
attributes:
24+
label: Steps to Reproduce
25+
description: To help us recreate the bug, provide a numbered list of the exact steps taken to trigger the buggy behavior.
26+
value: |
27+
If you know the steps, follow the below format and provide steps to reproduce
28+
29+
For example:
30+
31+
1. Go to <replace your> page.
32+
1. On top right side, close to the <Account> menu
33+
1. Some menu are not working properly.
34+
1. Continue...
35+
36+
If you don't know exact steps, include any relevant details like:
37+
38+
- What page you were on...
39+
- What you were trying to do...
40+
- What went wrong...
41+
validations:
42+
required: true
43+
- type: textarea
44+
id: screenshots
45+
attributes:
46+
label: Screenshots
47+
description: If applicable, add screenshots to help explain your problem.
48+
validations:
49+
required: false
50+
- type: dropdown
51+
id: assignee
52+
attributes:
53+
label: Do you want to work on this issue?
54+
multiple: false
55+
options:
56+
- "No"
57+
- "Yes"
58+
default: 0
59+
validations:
60+
required: false
61+
- type: textarea
62+
id: extrainfo
63+
attributes:
64+
label: If "yes" to above, please explain how you would technically implement this
65+
description: For example reference any existing code
66+
validations:
67+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: Project Security Vulnerabilities
4+
url: https://hey.new/ola
5+
about: Please report security vulnerabilities privately here.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: 💡 Feature Request
2+
description: Suggest an idea for this project
3+
title: "[FEATURE]: "
4+
labels: ["💡 idea"]
5+
body:
6+
- type: checkboxes
7+
id: duplicates
8+
attributes:
9+
label: Is this a unique feature/idea?
10+
description: Increase the chances of your issue being accepted by making sure it has not been raised before.
11+
options:
12+
- label: I have checked "open" AND "closed" issues and this is not a duplicate
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: Is your feature request related to a problem/unavailable functionality? Please describe.
17+
description: A clear and concise description of what the problem is (for example "I'm always frustrated when [...]").
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: description
22+
attributes:
23+
label: Proposed Solution
24+
description: A clear description of the enhancement you propose. Please include relevant information and resources (for example another project's implementation of this feature).
25+
validations:
26+
required: true
27+
- type: textarea
28+
id: screenshots
29+
attributes:
30+
label: Screenshots
31+
description: Please add screenshots of the before and/or after the proposed changes.
32+
validations:
33+
required: false
34+
- type: dropdown
35+
id: assignee
36+
attributes:
37+
label: Do you want to work on this issue?
38+
multiple: false
39+
options:
40+
- "No"
41+
- "Yes"
42+
default: 0
43+
validations:
44+
required: false
45+
- type: textarea
46+
id: extrainfo
47+
attributes:
48+
label: If "yes" to above, please explain how you would technically implement this
49+
description: For example reference any existing code
50+
validations:
51+
required: false

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Description
2+
<!-- Please add PR description (don't leave blank) - example: This PR [adds/removes/fixes/replaces] the [feature/bug/etc] -->
3+
4+
5+
6+
### Related Issue
7+
<!-- Please prefix the issue number with Fixes/Resolves - example: Fixes #123 or Resolves #123 -->
8+
9+
10+
11+
### Screenshots/Screencasts
12+
<!-- Please provide screenshots or video recording that demos your changes (especially if it's a visual change) -->
13+
14+
15+
16+
### Notes to Reviewer
17+
<!-- Please state here if you added a new npm packages, or any extra information that can help reviewer better review you changes -->
18+
19+

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -150,3 +150,6 @@ pnpm-debug.log*
150150

151151
# macOS-specific files
152152
.DS_Store
153+
154+
# Vercel build
155+
.vercel

‎CODE_OF_CONDUCT.md‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
This Contributor Covenant Code of Conduct outlines our expectations for all contributors to ensure a welcoming and inclusive environment.
4+
5+
## Our Pledge
6+
7+
In the interest of fostering an open and welcoming environment, we as
8+
contributors and maintainers pledge to making participation in our project and
9+
our community a harassment-free experience for everyone, regardless of age, body
10+
size, disability, ethnicity, sex characteristics, gender identity and expression,
11+
level of experience, education, socio-economic status, nationality, personal
12+
appearance, race, religion, or sexual identity and orientation.
13+
14+
## Our Standards
15+
16+
Examples of behavior that contributes to creating a positive environment
17+
include:
18+
19+
* Using welcoming and inclusive language
20+
* Being respectful of differing viewpoints and experiences
21+
* Gracefully accepting constructive criticism
22+
* Focusing on what is best for the community
23+
* Showing empathy towards other community members
24+
25+
Examples of unacceptable behavior by participants include:
26+
27+
* The use of sexualized language or imagery and unwelcome sexual attention or
28+
advances
29+
* Trolling, insulting/derogatory comments, and personal or political attacks
30+
* Public or private harassment
31+
* Publishing others' private information, such as a physical or electronic
32+
address, without explicit permission
33+
* Other conduct which could reasonably be considered inappropriate in a
34+
professional setting
35+
36+
## Our Responsibilities
37+
38+
Project maintainers are responsible for clarifying the standards of acceptable
39+
behavior and are expected to take appropriate and fair corrective action in
40+
response to any instances of unacceptable behavior.
41+
42+
Project maintainers have the right and responsibility to remove, edit, or
43+
reject comments, commits, code, wiki edits, issues, and other contributions
44+
that are not aligned to this Code of Conduct, or to ban temporarily or
45+
permanently any contributor for other behaviors that they deem inappropriate,
46+
threatening, offensive, or harmful.
47+
48+
## Scope
49+
50+
This Code of Conduct applies both within project spaces and in public spaces
51+
when an individual is representing the project or its community. Examples of
52+
representing a project or community include using an official project e-mail
53+
address, posting via an official social media account, or acting as an appointed
54+
representative at an online or offline event. Representation of a project may be
55+
further defined and clarified by project maintainers.
56+
57+
## Enforcement
58+
59+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
60+
reported by contacting the project team at [hey.new/ola](https://hey.new/ola). All
61+
complaints will be reviewed and investigated and will result in a response that
62+
is deemed necessary and appropriate to the circumstances. The project team is
63+
obligated to maintain confidentiality with regard to the reporter of an incident.
64+
Further details of specific enforcement policies may be posted separately.
65+
66+
Project maintainers who do not follow or enforce the Code of Conduct in good
67+
faith may face temporary or permanent repercussions as determined by other
68+
members of the project's leadership.
69+
70+
## Attribution
71+
72+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
73+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
74+
75+
[homepage]: https://www.contributor-covenant.org
76+
77+
For answers to common questions about this code of conduct, see
78+
https://www.contributor-covenant.org/faq

‎CONTRIBUTING.md‎

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# Contributing Guide
2+
3+
We welcome contributions of any size and skill level. Before contributing,
4+
please read the [Code of Conduct](./code-of-conduct.md) and follow the directions below:
5+
6+
> [!Tip]
7+
> **New contributors:** Take a look at [https://github.com/firstcontributions/first-contributions](https://github.com/firstcontributions/first-contributions) for helpful information on contributing
8+
9+
## Recommended Communication Style
10+
11+
1. Always leave screenshots for visual changes.
12+
2. Always leave a detailed description in the pull request. Leave nothing ambiguous for the reviewer.
13+
3. Always review your code first. Run the project locally and test it before requesting a review.
14+
4. Always communicate in the GitHub repository. Whether in the issue or the pull request, keeping the lines of communication open and visible to everyone on the team helps everyone around you.
15+
16+
## Contributing (New/Edit) Words to the Dictionary
17+
18+
Contributing new or edited words to the dictionary!? there are two primary ways you can contribute new words or edit existing ones:
19+
20+
1. **Using the Jargons Editor (Highly Recommended):**
21+
The Jargons Editor is a user-friendly interface built to simplify the contribution process. You can add new words or edit existing ones directly through the visual editor. Visit [jargons.dev/editor](https://jargons.dev/editor) to get started.
22+
23+
2. **Using GitHub UI or Other Means:**
24+
If you prefer to use the GitHub UI or other means, you can follow these steps:
25+
26+
- **For New Words:**
27+
1. Grab our predefined word template below
28+
```md
29+
---
30+
layout: ../../layouts/word.astro
31+
title: "title_here"
32+
---
33+
content_here
34+
```
35+
2. Fill in the word details in the template, ensuring accuracy and clarity.
36+
3. Create a new file for the word in the `src/content/dictionary` folder.
37+
4. Name the file in a slug format, e.g., `new-word.mdx`.
38+
5. Submit your file as a pull request to the `main` branch of our repository.
39+
40+
- **For Editing Existing Words:**
41+
1. Locate the existing file for the word you wish to edit in the `src/content/dictionary` folder.
42+
2. Make your edits directly to the file.
43+
3. Submit your changes as a pull request to the `main` branch of our repository.
44+
45+
## Contributing Issues & Pull Requests (PR)
46+
47+
For contributions other than adding or editing words in the dictionary, please refer to the guidelines below.
48+
49+
### Creating an Issue
50+
51+
To create an Issue, please follow these steps:
52+
53+
1. Search existing Issues before creating a new issue (to see if someone raised this already)
54+
2. If it doesn't exist create a new issue giving as much context as possible (please select the correct Issue type, for example `bug` or `feature`)
55+
3. If you wish to work on the Issue, Select the checkbox "I will like to work on this issue".
56+
57+
### Working on an Issue
58+
59+
If you wish to work on an open issue, please ask for it to be assigned to you and it will be assigned to you.
60+
61+
> [!Important]
62+
> Only start working on an Issue (and open a Pull Request) when it has been assigned to you - this will prevent confusion, multiple people working on the same issue and work not being used
63+
64+
In case you get stuck while working on an issue you've been assigned, feel free to ask question openly in the comment.
65+
66+
Please follow our [Code of Conduct](./code-of-conduct.md) in all your interactions with the project and its contributors.
67+
68+
### Pull Requests (PR)
69+
70+
We actively welcome your pull requests. However, you must ensure that **you are assigned** to an existing issue before working on a pull request, and you need to **link your work to the issue** in your PR form.
71+
72+
1. Fork and clone the repo.
73+
2. Creating a new branch is a must. Before working on your changes, create a new branch from the default (`main`, `beta`, etc.) branch. Name your branch with something descriptive of your work, i.e., `add-navbar` or `fix/broken-links`.
74+
3. If you've added code that should be tested, add tests.
75+
4. If you've changed APIs, update the documentation.
76+
5. If you make visual changes, screenshots are required.
77+
6. Ensure the test suite passes.
78+
7. Make sure you address any lint warnings.
79+
8. If you improve the existing code or added a new npm package, please let us know in your PR description.
80+
9. Completing the PR form is required. Make sure to fill in the PR title, description, [link to an issue](https://help.github.com/en/github/writing-on-github/autolinked-references-and-urls), and all the necessary areas.
81+
82+
- The title must begin with `feat:`, `fix:`, or anything related to your changes. <br /> **TIP:** You can follow your chosen option when [committing](#commits) your changes.
83+
84+
- Unsolicited code is welcomed, but an issue is required to announce your intentions.
85+
86+
#### Work in Progress
87+
88+
GitHub supports [draft pull requests](https://github.blog/2019-02-14-introducing-draft-pull-requests/), which will disable the merge button until the PR is marked as ready for merge.
89+
90+
#### Additional Resources
91+
92+
- _[3 tips for getting your Pull Request reviewed on GitHub](https://youtu.be/cuMeC-eZJJ4)_
93+
94+
## Getting Started
95+
96+
To contribute to jargons.dev, follow these steps:
97+
98+
### Setting Up Projects Locally
99+
100+
1. [Fork](https://docs.github.com/en/get-started/quickstart/fork-a-repo) the repository to your own GitHub account.
101+
2. Clone the forked repository to your local machine.
102+
3. Check the project's [README](./README.md) to learn more on how to run the project locally.
103+
104+
### Building
105+
106+
To generate a production-ready version of your code, run:
107+
108+
```shell
109+
npm run build
110+
```
111+
112+
## License
113+
114+
By contributing to the jargons.dev project, you agree that your contributions will be licensed
115+
by a specific License. You can find this information in the `LICENSE` file of the repo you are contributing to.
116+
117+
## Credits
118+
119+
This document was created picking some ideas from the ones listed below
120+
121+
- https://github.com/open-sauced/docs/blob/main/docs/contributing/introduction-to-contributing.md
122+
- https://github.com/EddieHubCommunity/BioDrop/blob/main/CONTRIBUTING.md

0 commit comments

Comments
 (0)