Contributing

Pull requests with bug fixes and new features are much appreciated. We are happy to review PRs and merge them once they are ready, as long as they fit within the vision of Framna Docs.

To start working on the Framna Docs project, you will need to run the app locally as described in Running Framna Docs Locally.

Vision

The vision for Framna Docs is:

• Centralize OpenAPI documentation for multiple services, making it easier for developers to locate and manage documentation.
• Facilitate spec-driven development by ensuring OpenAPI specifications are kept under version control and changes are carefully peer-reviewed.

Getting changes into the codebase

We welcome changes to the codebase. Changes should be submitted through a pull request and will be carefully peer-reviewed. To be considered, changes must adhere to the vision, be well-designed, and well-tested.

Pull requests will only be approved once all checks pass:

• The project must successfully build for production.
• Linting must succeed with no warnings or errors.
• All unit tests must pass.

You can verify that the production build succeeds by running npm build locally, linting by using npm lint, and unit tests by using npm test. It's worth verifying that all three checks pass locally before opening a pull request.

License

Framna Docs is released under the MIT license and all changes made to the codebase will be released under the same license. For more details, see the LICENSE file.