Skip to content

Latest commit

 

History

History
154 lines (80 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

154 lines (80 loc) · 3.89 KB
Raw

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:

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:

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:

git commit -m "Add [feature/bugfix] - Description of your changes"

7. Push Your Changes

Push the changes to your forked repository:

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:

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 file for details.

Additional Resources

Thank you for contributing! Your efforts make government data more transparent, accessible, and valuable to all citizens. 🚀 Happy coding!