> For the complete documentation index, see [llms.txt](https://documentarians.gitbook.io/metadocumentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://documentarians.gitbook.io/metadocumentation/clone/developers/guidelines.md).

# Best Practice Guidelines

## General rules

* When adding new dependencies, we use [fixed versions](https://docs.npmjs.com/about-semantic-versioning).
* Don't commit `package-lock.json` if you're not making any changes to the libraries.
* If the issue you're working on require changes in both API and Frontend, give your Git branches the same name. CI will automatically pull the correct API's branch when testing the Frontend.
* We **love** screenshots - or better: screencasts. Include some in your pull requests to demonstrate your changes and you will have our eternal gratitude.

## Frontend rules

* I18n
  * The strings must be internationalized. See [/help/developers/translations](https://docs.opencollective.com/help/developers/translations)
  * Update the language files `npm run build:langs` and commit them to reflect the changes
* Librairies
  * Whenever it's possible we must use `styled-components` to write styles. See [OC Styleguide](https://opencollective-styleguide.now.sh/)
  * We're getting rid of `Bootstrap` and `material-ui`. Please don't use them for new developments.
  * Icons must be imported from the [styled-icons](http://styled-icons.js.org/) library.
* Testing
  * Tests written with Cypress must follow our [good practices](https://docs.opencollective.com/help/developers/testing-with-cypress) conventions.


---

# 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, and the optional `goal` query parameter:

```
GET https://documentarians.gitbook.io/metadocumentation/clone/developers/guidelines.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.