๐ฅ First Timers Only โ Good First Issue
This issue is reserved for new contributors to this repository or anyone who is new to open source in general.
We understand that making your first pull request (PR) can be overwhelming, and we're here to help!
The purpose of this issueโand others labeled with good first issueโis to guide you through your first open-source contribution.
๐พ Issue Description
The ClyCites Website currently does not support internationalization (i18n), which limits accessibility for non-English users.
We want to enable multiple language support so that users can easily switch between languages (e.g., English, French, German etc.).
This will make the platform more inclusive and future-ready.
๐พ Task Description
Inside the ClyCites/ folder (which contains the website project), implement internationalization using a recommended library such as:
The implementation should:
- Add basic language switcher (UI component) in the header or settings area.
- Provide JSON translation files for at least 2 languages (e.g.,
en.json and fr.json).
- Wrap components/pages with the chosen i18n provider.
- Ensure static text (e.g., navigation, footer, homepage sections) is translated via the i18n system.
โ
Acceptance Criteria
๐ Step-by-Step Guide to Contribute
-
Comment below to claim this issue.
-
Wait for a maintainer to assign it to you.
-
Fork the repo, then clone your fork locally.
-
Create a new branch:
git checkout -b issue-{{issueNumber}}-add-tests
๐ ๏ธ Implement the Fix
-
Add or update the necessary tests in the codebase.
-
Ensure your tests cover all edge cases and scenarios mentioned in the issue description.
-
Commit your changes with a clear message:
git commit -s -m "test: add coverage for {{methodName}} in {{ClassName}}"
-
Ensure your commit is signed off with -s to comply with the Developer Certificate of Origin.
-
Push your branch to your forked repository:
git push origin issue-{{issueNumber}}-add-tests
-
Open a Pull Request (PR) to the main repository.
-
Monitor GitHub Actions โ if any checks fail and you're unsure why, feel free to ask for help in the PR comments.
-
Respond to feedback and make any necessary changes requested during the code review.
-
Once approved, your PR will be merged by a maintainer.
-
Celebrate your first contribution to open source! ๐
๐ฅ First Timers Only โ Good First Issue
This issue is reserved for new contributors to this repository or anyone who is new to open source in general.
We understand that making your first pull request (PR) can be overwhelming, and we're here to help!
The purpose of this issueโand others labeled with
good first issueโis to guide you through your first open-source contribution.๐พ Issue Description
The ClyCites Website currently does not support internationalization (i18n), which limits accessibility for non-English users.
We want to enable multiple language support so that users can easily switch between languages (e.g., English, French, German etc.).
This will make the platform more inclusive and future-ready.
๐พ Task Description
Inside the
ClyCites/folder (which contains the website project), implement internationalization using a recommended library such as:The implementation should:
en.jsonandfr.json).โ Acceptance Criteria
en.json,fr.json, etc.) exist inside alocales/folder.ClyCites/.๐ Step-by-Step Guide to Contribute
Comment below to claim this issue.
Wait for a maintainer to assign it to you.
Fork the repo, then clone your fork locally.
Create a new branch:
git checkout -b issue-{{issueNumber}}-add-tests๐ ๏ธ Implement the Fix
Add or update the necessary tests in the codebase.
Ensure your tests cover all edge cases and scenarios mentioned in the issue description.
Commit your changes with a clear message:
git commit -s -m "test: add coverage for {{methodName}} in {{ClassName}}"Ensure your commit is signed off with
-sto comply with the Developer Certificate of Origin.Push your branch to your forked repository:
git push origin issue-{{issueNumber}}-add-testsOpen a Pull Request (PR) to the main repository.
Monitor GitHub Actions โ if any checks fail and you're unsure why, feel free to ask for help in the PR comments.
Respond to feedback and make any necessary changes requested during the code review.
Once approved, your PR will be merged by a maintainer.
Celebrate your first contribution to open source! ๐