CONTRIBUTING.md

Contributing to [Resource Catalogue Documentation]

We welcome contributions to improve the documentation! Please follow these steps:

1. Fork the repository: Fork the repository to your GitHub account and clone it to your local machine.

2. Create a new branch: Create a new branch with a meaningful name. For example: fix/typos-in-readme or add/installation-guide.

3. Make your changes:

   • Please ensure your changes improve the documentation clarity, fix typos, or update outdated information.
   • Use consistent style and formatting across documentation files.
   • Ensure all code examples are accurate and up-to-date.

4. Test your changes:

   • Check for spelling/grammar errors using tools like Grammarly.
   • Run a Markdown linter (e.g., markdownlint) to ensure consistency in the structure and formatting of the
   • documentation.
   • Verify links and images are correct and functional.
   • Preview locally: Render the documentation to ensure everything displays properly.

5. Submit a Pull Request: Once you’ve made the changes, commit them to your branch and submit a pull request.

6. Provide a clear description of what was changed and why. If applicable, explain any updates to code examples, tests,

7. or new sections you added.

8. Code of Conduct: Please ensure your contributions adhere to our Code of Conduct.

Thank you for helping us improve the documentation!