> For the complete documentation index, see [llms.txt](https://permasigner.itsnebula.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://permasigner.itsnebula.net/contribution/committing-and-making-a-pull-request.md).

# Committing and making a Pull Request

## Commit and Push changes

After every change you make and test, you should commit your changes. In VSCode, this is as easy as clicking the Source Control icon on the left, typing in a short description, and clicking commit. You can also sync changes to your fork (where the Actions will make sure the script still works, if enabled).

In a terminal `git add .`, `git commit -am "Your description here"`, and `git push -u origin main` will give the same result. Don't miss the dot at the end of the add command!

If you want to test the package, you can run `make build`, and it'll create a `whl` file in the `dist` directory. You can then run `pip install dist/the-name-of-the.whl`, and use `permasigner` to run it.

## Make a pull request

After you're finished implementing your changes, you'll want to request them to be added to the main repository.

* Make sure all your changes are pushed, as shown above
* Navigate to [this URL](https://github.com/permasigner/permasigner/compare) to open a new pull request
  * Keep base as main (which is Permasigner's main branch), and set compare as your fork's main branch (or the branch you were working in)
* Follow the template and create your pull request
  * It'll be reviewed as soon as possible


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://permasigner.itsnebula.net/contribution/committing-and-making-a-pull-request.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.