diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..e0e0ce3c --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,42 @@ +# Code of Conduct + +The goal is to create a community that is open and welcoming to all individuals. +To achieve this, we have developed a code of conduct that outlines the expectations for behavior of all members of our community. + +## Pledge + +This community is founded on respect and understanding. +All members are expected to treat others with respect and empathy, and to not tolerate any form of discrimination, +harassment, or attacks. + +## Expectations + +Examples of behavior that contributes to creating a positive environment include: + +- Using welcoming and inclusive language +- Being respectful of differing viewpoints and experiences +- Gracefully accepting constructive criticism +- Focusing on what is best for the community +- Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +- The use of sexualized language or imagery and sexual attention or advances +- Trolling, insulting/derogatory comments, and personal or political attacks +- Public or private harassment +- Publishing others' private information, such as a physical or electronic address, without explicit permission +- Other conduct which could reasonably be considered inappropriate in a professional setting + +## Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate +and fair corrective action in response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, +issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily +or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. + +## Contact + +If you feel uncomfortable or believe that someone has violated the code of conduct, please contact us at [hello@solidtime.io](mailto:hello@solidtime.io). +We will thoroughly investigate the incident and aim for the best possible outcome. diff --git a/README.md b/README.md index 20e8c00b..b05a1645 100644 --- a/README.md +++ b/README.md @@ -2,11 +2,24 @@ ![GitHub License](https://img.shields.io/github/license/solidtime-io/solidtime) ![Codecov](https://img.shields.io/codecov/c/github/solidtime-io/solidtime?style=flat-square&logo=codecov) -![GitHub Actions Unit Tests Status](https://img.shields.io/github/actions/workflow/status/solidtime-io/solidtime/phpunit?style=flat-square) -![PHPstan badge](https://img.shields.io/badge/PHPstan-Level_9-blue?style=flat-square&color=blue) +![GitHub Actions Unit Tests Status](https://img.shields.io/github/actions/workflow/status/solidtime-io/solidtime/phpunit.yml?style=flat-square) +![PHPStan badge](https://img.shields.io/badge/PHPstan-Level_7-blue?style=flat-square&color=blue) ![Screenshot of the solidtime application with header: solidtime - The modern Open-Source Time Tracker](docs/solidtime-banner.png "solidtime Banner") +solidtime is a modern open-source time tracking application for Freelancers and Agencies. + +## Features + + - Time tracking: Track your time with a modern and easy-to-use interface + - Projects: Create and manage projects and assign project members + - Tasks: Create and manage tasks and assign tasks to project members + - Clients: Create and manage clients and assign clients to projects + - Billable rates: Set billable rates for projects, project members, organization members and organizations + - Multiple organizations: Create and manage multiple organizations with one account + - Roles and permissions: Create and manage organizations + - Import: Import your time tracking data from other time tracking applications (Supported: Toggl, Clockify, Timeentry CSV) + ## Local setup for development **System requirements** @@ -81,10 +94,14 @@ npm run zod:generate ## Contributing This project is in a very early stage. The structure and APIs are still subject to change and not stable. -Therefore we do not currently accept any contributions, unless you are a member of the team. +Therefore, we do not currently accept any contributions, unless you are a member of the team. As soon as we feel comfortable enough that the application structure is stable enough, we will open up the project for contributions. +## Security + +Looking to report a vulnerability? Please refer our [SECURITY.md](./SECURITY.md) file. + ## License This project is open-source and available under the GNU Affero General Public License v3.0 (AGPL v3). Please see the [license file](LICENSE.md) for more information. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..254017f6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,5 @@ +# Security Policy + +## Reporting a Vulnerability + +If you discover a security vulnerability regarding this project, please e-mail me to [security@solidtime.io](mailto:security@solidtime.io)! diff --git a/public/security.txt b/public/security.txt new file mode 100644 index 00000000..49c825d5 --- /dev/null +++ b/public/security.txt @@ -0,0 +1,2 @@ +Contact: mailto:security@solidtime.io +Expires: 2025-03-31T10:00:00.000Z