add SUPPORT.md and RELEASE.md to improve project documentation for support & release process #53
Conversation
Signed-off-by: AkarshSahlot <akarshsahlot7@gmail.com>
|
Hi @WillSams @axmsoftware , |
subhramit
left a comment
subhramit
left a comment
There was a problem hiding this comment.
Some comments. Please revert back if unclear.
| #### GitHub Discussions (if available) | ||
|
|
||
| - For general questions, ideas, and community discussions | ||
| - Share your APIS use cases and implementations | ||
| - Get help from the community |
There was a problem hiding this comment.
We are supposed to make documentation project-specific. At the current state, this reads like introduction to GitHub features. Note that our repository doesn't support discussions (yet).
If an LLM generated this, can you cross-verify the content of this PR and revert back, so that it can be merged?
| #### GitHub Issues | ||
|
|
||
| - For bug reports, feature requests, and technical questions: <https://github.com/hyphae/APIS/issues> | ||
| - Search existing issues before creating new ones to avoid duplicates | ||
| - Use appropriate issue templates when available |
There was a problem hiding this comment.
These sound like contributing guidelines to me, and should go into CONTRIBUTING.md if not already present.
| ### For Bug Reports | ||
|
|
||
| - **Clear description**: What you expected to happen vs. what actually happened | ||
|
|
||
| - **Environment details**: OS, Python version, Java version, hardware setup | ||
| - **Reproduction steps**: Detailed steps to reproduce the issue | ||
| - **Error logs**: Include relevant error messages and stack traces | ||
| - **Configuration**: Share relevant configuration files (with sensitive data removed) |
There was a problem hiding this comment.
Good ideas - we should also incorporate this into our issue template. Can you take that up?
| ### For Feature Requests | ||
|
|
||
| - **Use case description**: Why you need this feature | ||
| - **Proposed solution**: Your ideas for implementation | ||
| - **Alternatives considered**: Other approaches you've evaluated | ||
| - **Impact assessment**: How this would benefit the community |
There was a problem hiding this comment.
Should go into issue template type: feature
| - **Individual component docs**: Each APIS component has its own documentation: | ||
| - apis-main | ||
| - apis-emulator | ||
| - apis-web | ||
| - apis-main_controller |
There was a problem hiding this comment.
use backticks, and also link respective documentation being talked about
|
|
||
| - **DO NOT** create public GitHub issues for security vulnerabilities | ||
| - Contact the project maintainers privately first | ||
| - If no security contact is provided, email: <security@lfenergy.org> |
|
|
||
| - **Project Repository**: <https://github.com/hyphae/APIS> | ||
| - **LF Energy Foundation**: <https://lfenergy.org> | ||
| - **General LF Energy Contact**: <info@lfenergy.org> |
There was a problem hiding this comment.
We don't have a well-defined release process yet, and I am not sure if a project like this should follow Semantic Versioning or periodic release cycles at this stage. Can shift this file to a draft PR and discard this file from this PR's changes? We can discuss more there.
There was a problem hiding this comment.
I will go through it once again and will revert back to older one.
Ok sir I will revert it back |
3 participants
This pull request addresses two essential documentation gaps in the APIS project:
Both documents aim to improve onboarding, support clarity, and release process transparency for the APIS community and for newcomers.
@axmsoftware @WillSams
Closes #13
Closes #14