> For the complete documentation index, see [llms.txt](https://docs.opencollective.com/help/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.opencollective.com/help/contributing/development/best-practice-guidelines.md).

# Best Practice Guidelines

Describes what we expect from new code. Also includes special tips to help you getting started!

## 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 requires 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.
* Libraries
  * Whenever it's possible, we must use `styled-components` to write styles. See[ OC Styleguide.](https://styleguide.opencollective.com/)
  * We're getting rid of `material-ui`. We still rely on this library for some stuff but please don't use it directly.
  * 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 by asking a question.

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

```
GET https://docs.opencollective.com/help/contributing/development/best-practice-guidelines.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.