added CONTRIBUTING.md and updated README.md

CONTRIBUTING.md

@@ -0,0 +1,154 @@
+# Contributing to OK Lab Flensburg Projects
+
+Thank you for your interest in contributing to this OK Lab Flensburg project! We welcome contributions that help improve #opendata, #civictech, and #opengovernment applications and prototypes. By contributing, you are making social demographic government data more accessible and usable for everyone.
+
+
+---
+
+
+## How to Contribute
+
+We appreciate all types of contributions, including:
+
+- Bug fixes.
+- Code improvements.
+- Documentation enhancements.
+- New features or ideas.
+
+Follow these steps to get started:
+
+
+### 1. Fork the Repository
+
+Click the **Fork** button at the top-right corner of this repository’s page to create your own copy.
+
+
+### 2. Clone the Repository
+
+Clone your forked repository to your local machine:
+
+```bash
+git clone https://github.com/your-username/your-project.git
+```
+
+
+### 3. Create a Branch
+
+Create a new branch for your contribution. Use a descriptive branch name:
+
+```bash
+git checkout -b feature/your-feature-name
+```
+
+
+### 4. Make Changes
+
+- Implement your changes in the codebase, documentation, or other project files.
+- Write clear and concise comments to explain your code.
+- Update any relevant documentation if needed.
+
+
+### 5. Test Your Changes
+
+- Verify that your changes work as expected.
+- Add tests if your changes introduce new functionality or fix a bug.
+
+
+### 6. Commit Your Changes
+
+Write a clear and descriptive commit message:
+
+```bash
+git commit -m "Add [feature/bugfix] - Description of your changes"
+```
+
+
+### 7. Push Your Changes
+
+Push the changes to your forked repository:
+
+```bash
+git push origin feature/your-feature-name
+```
+
+
+### 8. Create a Pull Request
+
+Submit a Pull Request (PR) to the original repository. Include:
+
+- A detailed description of your changes.
+- Links to any related issues (e.g., `Fixes #123`).
+- Screenshots, logs, or other supporting information if applicable.
+
+
+---
+
+
+## Code Style and Guidelines
+
+To maintain consistency and readability, we follow specific code style guidelines. Please ensure your contributions adhere to the following:
+
+- Write clear and concise comments.
+- Follow the project's existing code patterns and structure.
+- Ensure that each Pull Request addresses a single issue or implements a specific feature.
+- Run `pnpm run lint` (or the equivalent for this project) to check for formatting or style issues.
+
+
+### Checklist Before Submitting Your PR:
+
+- [ ] Code is properly formatted.
+- [ ] Tests are included and passing.
+- [ ] Documentation is updated, if applicable.
+- [ ] Changes are scoped and focused.
+
+
+---
+
+
+## Reporting Issues
+
+Found a bug or have an idea? Let us know! Use the Issue Tracker to report issues or suggest improvements.
+
+
+### Include the Following When Reporting Issues:
+
+1. **Description**: Clearly describe the issue or feature request.
+2. **Steps to Reproduce**: Provide step-by-step instructions to replicate the issue.
+3. **Expected Behavior**: Explain what you expected to happen.
+4. **Actual Behavior**: Describe what actually happened.
+5. **Environment Details**: Include operating system, browser version, or other relevant details.
+
+
+---
+
+
+## Community and Communication
+
+We value open, respectful, and inclusive communication. If you need help or have questions:
+
+- Join our [Slack community](https://openknowledgegermany.slack.com) for discussions and support.
+- Email the project maintainers at [[email protected]](mailto:[email protected]).
+
+
+---
+
+
+## License
+
+By contributing to this project, you agree that your contributions will be licensed under the same license as the project. Refer to the [LICENSE](LICENSE) file for details.
+
+
+---
+
+
+## Additional Resources
+
+- [GitHub Guides: Forking Projects](https://guides.github.com/activities/forking/)
+- [How to Write a Good Commit Message](https://chris.beams.io/posts/git-commit/)
+
+
+---
+
+
+Thank you for contributing! Your efforts make government data more transparent, accessible, and valuable to all citizens. 🚀
+**Happy coding!**

README.md

@@ -155,6 +155,17 @@ FROM (
 ```
 
 
-## LICENSE
+---
 
-[CC0-1.0](LICENSE)
+
+## How to Contribute
+
+Contributions are welcome! Please refer to the [CONTRIBUTING.md](CONTRIBUTING.md) guide for details on how to get involved.
+
+
+---
+
+
+## License
+
+This repository is licensed under [CC0-1.0](LICENSE).