Issues and pull requests
Bug reports, fixes for portal changes and docs improvements are all welcome. Issues and PRs in English or Korean are fine.
Start with an issue
Section titled “Start with an issue”- Bugs: include the error code (
SejongAuthException.getErrorCode()and so on), the method you called, and the language and version. - If authentication broke because the portal changed, first check whether the live demo reproduces it.
- For larger changes, agree on the direction in an issue before opening a PR.
- For a new school data source, use the
새 정보 출처 제안(new data source proposal) template. The steps are in Add a new data source.
Labels
Section titled “Labels”| Label | Use |
|---|---|
good first issue |
Fits someone who is new |
help wanted |
Issues that need a hand |
data-source |
Proposals of new school data sources |
Where to post
Section titled “Where to post”| You want to | Go to |
|---|---|
| Ask a usage question, suggest something, share a data source idea | Discussions |
| Report a bug (a reproducible problem) | Issues |
| Report a vulnerability | Private reporting, not a public issue |
| Fix or add something yourself | CONTRIBUTING.en.md |
Check the FAQ and the error codes first. This is a personal open-source project and answers come from volunteers, so they can take time.
Security reports
Section titled “Security reports”This library handles Sejong University portal passwords, so security reports are taken seriously. Do not open a public issue.
- Go to the repository’s Security tab.
- Click Report a vulnerability.
- Describe the issue, the affected version and the steps to reproduce. Never include real student IDs, passwords or other personal data.
You can expect a first response within 7 days. Only the latest released version receives security fixes. The scope is this library’s code, for example leaking passwords or personal data through logs, exceptions or results, unsafe TLS handling, or session mix-ups between calls. Details are in SECURITY.md.
Pull request rules
Section titled “Pull request rules”- Branch from
main. - Add tests when behavior changes. Parser changes need a fixture in
spec/fixtures/and the same expected values for all languages. - When the portal changed, fix the three languages in the same PR. The steps are in Repository structure.
- Make sure no password or personal data ends up in logs or exception messages.
- For a new feature, go through the feature exposure checklist.
PRs written with an AI agent
Section titled “PRs written with an AI agent”PRs written with a coding agent are welcome. The person submitting the PR must run the commands in the repository’s AGENTS.md and confirm they pass, and the PR description should say which agent was used. Never include personal data or real school responses (synthetic values only). The review bar is the same as for human-written PRs.
Code of conduct and license
Section titled “Code of conduct and license”Participants follow the Code of Conduct. Contributions are released under the MIT License.