> For the complete documentation index, see [llms.txt](https://rc.sunbird.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://rc.sunbird.org/engage/contributing.md).

# Contributing

Thank you for your interest in contributing to Sunbird Registry and Credentials (RC). Contributions of every kind are welcome, and you don't need to be a programmer to make one — reporting a bug, improving a page of these docs or answering someone's question all count.

<a href="https://github.com/Sunbird-RC/sunbird-rc-core?tab=contributing-ov-file#sunbird-rc-contributing-guide" class="button primary" data-icon="github">Read the contributing guide</a> <a href="https://github.com/Sunbird-RC/sunbird-rc-core/issues?q=is%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22" class="button secondary">Find a good first issue</a>

## Ask a question

Start with this documentation site, then search the [community discussions](https://github.com/Sunbird-RC/community/discussions). If you still need help, open a new discussion. See [Discussion Forum](https://rc.sunbird.org/engage/discussions) for all the ways to reach the community.

## Report bugs or request features

Search the [issue tracker](https://github.com/Sunbird-RC/sunbird-rc-core/issues) first, in case someone has already reported it. If not, [open an issue](https://github.com/Sunbird-RC/sunbird-rc-core/issues/new/choose) and pick the bug report or feature request template.

{% hint style="danger" %}
Never report security vulnerabilities in a public issue. Use the **Security → Report a vulnerability** tab on the [sunbird-rc-core repository](https://github.com/Sunbird-RC/sunbird-rc-core/security) instead.
{% endhint %}

## Contribute to the core registry and services

The [Sunbird RC contributing guide](https://github.com/Sunbird-RC/sunbird-rc-core?tab=contributing-ov-file#sunbird-rc-contributing-guide) in the `sunbird-rc-core` repository covers everything you need: setting up and building the stack, which branch to work from, running the tests, and the checklist to complete before opening a pull request.

## Contribute to the Registry CLI

Take a look at the [contributing guide for the Registry CLI](https://github.com/Sunbird-RC/registry-cli/blob/main/contributing.md) and jump straight into fixing bugs or adding new features.

## Improve documentation

Documentation fixes are real contributions and an ideal first one — if something tripped you up during setup, that's a genuine bug. Most user-facing documentation lives on this site; Markdown in the `sunbird-rc-core` repository covers the build, the services and the compose setup.

Useful documentation contributions include:

* making a page clearer or easier to follow
* fixing typos, broken links or wrong commands
* adding a section about something new
* documenting something that was previously left out

To suggest a change to this site, [open an issue](https://github.com/Sunbird-RC/sunbird-rc-core/issues/new/choose) naming the page and what should change. For in-repository docs, open a pull request.

## Before you start

Read the [Contribution Guidebook](https://rc.sunbird.org/engage/contribution-guidebook) to see how we work as a community, and the [Code of Conduct](https://rc.sunbird.org/engage/code-of-conduct) that everyone taking part is expected to follow.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://rc.sunbird.org/engage/contributing.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.