jargonsdev / jargonsdev/jargons.dev

Tasks: Going Open Source

Open
#55 0 comments 0 reactions 1 assignee View on GitHub

@babblebey is already working on this.

Since Apr 21, 2024.

:scroll: documentation :spiral_notepad: todo maintainers-only
Dominant language
MDX
Stars
56
Forks
45
PR merge metrics
No merged PRs in 30d

Description

Prepare jargons.dev to go open source:

- [x] **License**: Choose an open-source license for the project and add the license file to the repository.
- [x] **README**: Update the README file with detailed instructions on how to set up the project, contribute, and any other relevant information.
- [x] **Code of Conduct**: Include a Code of Conduct to set guidelines for community behavior.
- [x] **Contributing Guidelines**: Provide clear guidelines for how to contribute to the project, including how to report issues and submit pull requests.
- [x] **Issue Template**: Create an issue template to standardize the information needed when submitting new issues.
- [x] **Pull Request Template**: Similarly, create a pull request template to guide contributors on what information to include in their pull requests.
- [x] **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.
- [x] **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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.