Skip to content

Taskist/docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 

Repository files navigation

🧩 Contributing to Taskist

Thank you for your interest in contributing to Taskist!
We’re excited to have your help in improving and growing this open-source project.


💡 About Taskist

Taskist is an open-source task, bug, feature tracking platform built with modern technologies.
It focuses on task management, collaboration, and automation — designed to empower individuals and teams.


🚀 Getting Started

1. Fork the Repository

  1. Click Fork on the top right of the Taskist GitHub repository.
  2. Clone your fork:
    git clone https://github.com/taskist/taskist.git
    cd taskist

2. Set Up Remotes

Keep your fork updated with the main repo:

git remote add upstream https://github.com/taskist/taskist.git

3. Create a Branch

Always create a new branch for your contribution:

git checkout -b feature/your-feature-name

🧠 Development Setup

Requirements

Folder Structure

Taskist.Core       → Core logic and entities
Taskist.Service    → Business services and interfaces
Taskist.Data       → Data access using EF Core / Dapper
Taskist.Web        → MVC / API layer

Run the Application

dotnet restore
dotnet build
dotnet run --project Taskist.Web

🧾 Code Guidelines

  • Follow C# naming conventions and SOLID principles
  • Write clean, readable, and commented code
  • Use interfaces for all services
  • Ensure Entity Framework migrations are up to date
  • Include unit tests where applicable

🧪 Testing

Run tests locally before creating a PR:

dotnet test

🧭 Submitting a Pull Request

  1. Commit your changes with a meaningful message:
    git commit -m "Add: feature description"
  2. Push your branch:
    git push origin feature/your-feature-name
  3. Open a Pull Request on GitHub.

🗣️ Discussions & Support

We use Zulip for discussions.
Join the conversation, ask questions, or share feedback!


📜 License

By contributing, you agree that your contributions will be licensed under the MIT License.


Thank you for helping make Taskist better! 🙌

About

No description, website, or topics provided.

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors