Skip to content

Latest commit

 

History

History
98 lines (50 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

98 lines (50 loc) · 3.1 KB
Raw

Contributing

Thank you for your interest in contributing to this OK Lab Flensburg project! We welcome contributions from the community to help improve #opendata #civictech and #opengovernment applications and prototypes. By contributing to this project, you are helping to make 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, and new features. To get started, follow these steps

Fork the Repository

Click the "Fork" button on the top right corner of this repository's page to create your own copy.

Clone the Repository

Clone your forked repository to your local machine using Git

git clone https://github.com/your-username/your-project.git

Create a Branch:

Create a new branch for your contribution. Choose a descriptive branch name

git checkout -b feature/your-feature-name

Make Changes

Make your desired changes to the codebase, documentation, or any other project files.

Test Your Changes: Test your changes to ensure they work as expected. If you're adding new features, make sure to document them properly.

Commit Your Changes

Commit your changes with a clear and concise commit message

git commit -m "Add your commit message here"

Push to Your Fork

Push your changes to your forked repository

git push origin feature/your-feature-name

Create a Pull Request

Go to the original repository and create a Pull Request (PR) from your forked branch to the main branch. Please provide a detailed description of your changes in the PR.

Code Style and Guidelines

We follow specific code style and guidelines to maintain consistency in our codebase. Before submitting your contribution, please make sure to

  • Write clear and concise code comments.
  • Keep your PRs focused on addressing a single issue or implementing a specific feature.

By running pnpm run lint, you can ensure that your code complies with the project's style and formatting standards, making it easier for reviewers to evaluate your contributions.

Reporting Issues

If you encounter any bugs, issues, or have suggestions for improvements, please report them on our Issue Tracker. When reporting issues, be sure to provide detailed information, including

  • A clear description of the problem.
  • Steps to reproduce the issue.
  • Expected and actual behavior.
  • Environment details (e.g., operating system, browser version, etc.).

Community and Communication

We value open and respectful communication within our community. If you have questions or need assistance, you can

  • Join our community in slack to discuss ideas or seek help.
  • Reach out to the project maintainers via email.

License

By contributing to this project, you agree that your contributions will be licensed under the project's license.

Thank you for contributing! Your efforts help make government data more transparent, accessible, and useful to citizens.

Happy coding!