Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tasks: Going Open Source #55

Open
8 of 10 tasks
babblebey opened this issue Apr 21, 2024 · 0 comments · Fixed by #63
Open
8 of 10 tasks

Tasks: Going Open Source #55

babblebey opened this issue Apr 21, 2024 · 0 comments · Fixed by #63
Assignees
Labels
📜 documentation Improvements or additions to documentation 🗒️ todo This issue is a follow-up task

Comments

@babblebey
Copy link
Member

babblebey commented Apr 21, 2024

Prepare jargons.dev to go open source:

  • License: Choose an open-source license for the project and add the license file to the repository.
  • README: Update the README file with detailed instructions on how to set up the project, contribute, and any other relevant information.
  • Code of Conduct: Include a Code of Conduct to set guidelines for community behavior.
  • Contributing Guidelines: Provide clear guidelines for how to contribute to the project, including how to report issues and submit pull requests.
  • Issue Template: Create an issue template to standardize the information needed when submitting new issues.
  • Pull Request Template: Similarly, create a pull request template to guide contributors on what information to include in their pull requests.
  • CI/CD Setup: Set up continuous integration and deployment pipelines to automate testing and deployment processes.
  • Documentation: Write project documentation, README files, and any other relevant documentation.
  • Release Process: Define a release process for versioning and releasing updates to the project.
  • Word File Template: Create a Word file template that contributors can copy and use for adding new words to the dictionary (for contributors who would like to contribute via conventional means).

Credits: ChatGPT 🤝 Me

@babblebey babblebey added 📜 documentation Improvements or additions to documentation 🗒️ todo This issue is a follow-up task labels Apr 21, 2024
@babblebey babblebey self-assigned this Apr 21, 2024
@babblebey babblebey pinned this issue Apr 22, 2024
@jargonsdev jargonsdev locked and limited conversation to collaborators Apr 22, 2024
@jargonsdev jargonsdev unlocked this conversation Apr 26, 2024
babblebey added a commit that referenced this issue Apr 26, 2024
### Description
<!-- Please add PR description (don't leave blank) - example: This PR
[adds/removes/fixes/replaces] the [feature/bug/etc] -->

This Pull request implements some tiny changes carried over from #63 and
addresses some todo that are simple enough.

#### Changes Made

- Implemented the submission visual cue on the word editor - this turns
the submission loading button green after a word submission is
successfully done before the redirection to he jargons editor dashboard
- Added "babblebey" to funding/sponsor this project section
- Extracted `addToRecentSearches` logic from `search` to `word.astro`
layout - this ensures that words are added to recent searches when
viewed and not only when they are searched using the search feature

### Related Issue
<!-- Please prefix the issue number with Fixes/Resolves - example: Fixes
#123 or Resolves #123 -->
- Resolves #10 
- #55 & #63

### Screenshots/Screencasts
<!-- Please provide screenshots or video recording that demos your
changes (especially if it's a visual change) -->

[screencast-bpconcjcammlapcogcnnelfmaeghhagj-2024.04.26-21_45_48.webm](https://github.com/babblebey/jargons.dev/assets/25631971/6ae8e447-9791-4de5-8ff9-46eb10bd2b8a)

### Notes to Reviewer
<!-- Please state here if you added a new npm packages, or any extra
information that can help reviewer better review you changes -->

_NA_
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📜 documentation Improvements or additions to documentation 🗒️ todo This issue is a follow-up task
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant