Skip to content

Latest commit

 

History

History
32 lines (22 loc) · 2.42 KB

CONTRIBUTING.md

File metadata and controls

32 lines (22 loc) · 2.42 KB

Contribution Guidelines for Bangkok CSR Matching Project

Welcome to the Bangkok CSR Matching Project! This is an open-source project aimed at connecting CSR activities to Bangkok's mayor policy and the United Nations Sustainable Development Goals. Our goal is to help individuals and organizations contribute to the betterment of Bangkok and the world. We welcome contributions from developers, designers, content creators, and anyone interested in supporting our mission.

Code of Conduct

We expect all contributors to abide by our code of conduct. We are committed to providing a safe, welcoming, and inclusive environment for everyone. Please read our code of conduct before contributing.

Scope of the Project

The Bangkok CSR Matching Project is focused on developing a web application using React and Typescript to match CSR activities with Bangkok's mayor policy and the United Nations Sustainable Development Goals. We are also using React Testing Library for unit tests, Playwright for end-to-end tests, and Material UI for styling.

Contributing Process

We welcome all contributions to the project. Here's how you can contribute:

  1. Fork the repository
  2. Create a new branch with a descriptive name for your contribution
  3. Commit your changes to the new branch
  4. Submit a pull request to the main branch

Testing and Review

We strongly encourage contributors to write tests for their code and to submit their contributions for review before merging them into the main branch. This will help ensure that the code meets project standards and is of high quality.

Style Guide

To ensure consistency in the project's code and documentation, we ask that contributors follow the Material UI and React community style guides. Please use clear and descriptive naming conventions for your code and avoid excessive nesting.

Documentation

We welcome contributions to our documentation. Please ensure that your documentation is clear, concise, and follows our style guide. All documentation should be in English.

License

The Bangkok CSR Matching Project is released under the MIT License. By contributing to the project, you agree to license your contributions under the same license.

Contact Information

If you have any questions or need support, please reach out to the project maintainer at [insert contact information]. Thank you for your contributions to the Bangkok CSR Matching Project!