Contributing
Report reproducible problems, improve examples or contribute a focused change to the public ngbootstrap library repository.
Report an issue
Include your Angular and ngbootstrap versions, the component configuration, expected behavior and a small reproduction. For visual issues, include the theme, viewport size and relevant custom CSS.
Work on the library
- Clone the public repository and follow its README and AGENTS.md instructions.
- Use the package-manager version declared in package.json and install its dependencies.
- Change the public library source and add focused tests for changed behavior.
- Run
pnpm test -- --runInBand,pnpm lintandpnpm build. - Open a pull request explaining the problem, the resulting behavior and your verification.
Documentation changes
The ngbootstrap.com docs workspace is maintained separately. You do not need access to that workspace to contribute to the library. Report incorrect documentation through a public issue with the page URL and suggested correction. Examples must describe exported library behavior and label unreleased work clearly.
Keep additions standalone, accessible and compatible with the supported Angular versions. Discuss large new APIs before implementation so their scope and maintenance needs are clear.