First off, thank you for considering contributing to this project! ❤️
Whether it's code, docs, ideas, or feedback, every contribution helps the project grow.
All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.
GradrX is a developer community building tools, learning resources, and platforms for the world, by developers. This guide will help you understand how to contribute effectively and collaboratively.
And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
- Star the project
- Tweet about it
- Refer this project in your project's readme
- Mention the project at local meetups and tell your friends/colleagues
- Code of Conduct
- I Have a Question
- I Want To Contribute
- Your First Code Contribution
- Improving The Documentation
- Commit Messages
- Join The Project Team
This project and everyone participating in it is governed by the GradrX Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to our Discord Server
Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue.
If you then still feel the need to ask a question and need clarification, we recommend the following:
- Open an Issue.
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, go, etc), depending on what seems relevant.
- Reach out to out Discord Server in case of any issue
We will then take care of the issue as soon as possible.
Contributions are welcome in many forms, not just code!
You can:
- Report bugs
- Suggest enhancements
- Improve documentation
- Enhance UI/UX
- Refactor or optimize code
- Build developer tools
- Spread the word about GradrX
When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project licence.
A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.
- Make sure that you are using the latest version.
- Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions. If you are looking for support, you might want to check this section.
- To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
- Collect information about the bug:
- Stack trace (Traceback)
- OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
- Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
- Possibly your input and the output
- Can you reliably reproduce the issue? And can you also reproduce it with older versions?
We use GitHub issues to track bugs and errors. If you run into an issue with the project:
- Open an Issue. (Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
- Provide the information you collected in the previous section.
Once it's filed:
- The project team will label the issue accordingly.
- A team member will try to reproduce the issue with your provided steps. If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as
needs-repro. Bugs with theneeds-reprotag will not be addressed until they are reproduced. - If the team is able to reproduce the issue, it will be marked
needs-fix, as well as possibly other tags (such ascritical), and the issue will be left to be implemented by someone.
This section guides you through submitting an enhancement suggestion for logkv-store, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
- Make sure that you are using the latest version.
- Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature.
Enhancement suggestions are tracked as GitHub issues.
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as many details as possible.
- Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives do not work for you.
- You may want to include screenshots or screen recordings which help you demonstrate the steps or point out the part which the suggestion is related to.
- Explain why this enhancement would be useful to most logkv-store users. You may also want to point out the other projects that solved it better and which could serve as inspiration.
- Pick an open issue or create a new one if you found a bug or have a feature suggestion.
- Comment on it to express your interest (so we can assign it).
- Fork the repo
- Create a feature branch:
git checkout -b feature/your-feature-name- Make your changes.
- Commit your changes with a meaningful message (see Commit Guidelines).
- Push your branch and create a Pull Request (PR) against
devbranch. - Wait for review — we’ll provide feedback and guide you through the process!
We value learning and collaboration — it’s okay to ask questions!
Documentation is as important as code! You can help by:
- Correcting typos or grammar errors.
- Adding missing setup or usage instructions.
- Updating outdated information.
- Adding examples, screenshots, or diagrams for clarity.
Every small improvement helps new contributors get started faster.
This project follows the Conventional Commits standard. Check Commit Guidelines for more details
Want to be more involved? Here’s how to get started:
- Follow the repo for updates.
- Participate in discussions via Issues and PRs.
- Take ownership of features: pick issues, implement them, and submit PRs.
- Become a core contributor: Regular contributors may be invited to the team with push access.
- Reach out to us at our Discord Server
You can ask for help in the #contribution-help or #dev-help channels — we’ll be there to assist! 💬 We encourage open communication, so don’t hesitate to ask questions or suggest improvements!
Thank you for helping make this project and the GradrX Community better! ❤️