Skip to content

Latest commit

 

History

History
99 lines (59 loc) · 1.55 KB

File metadata and controls

99 lines (59 loc) · 1.55 KB

We welcome all kinds of contributions — from bug fixes to feature enhancements, documentation, or even design ideas.

HOW TO CONTRIBUTE

-Fork the Repository

-Click the Fork button on the top-right of this repo.

-Clone your fork

git clone https://github.com/<your-username>/polarix.git
cd polarix

-Create a new branch

-Use a meaningful name related to your contribution.

git checkout -b feature/your-feature

-Make your changes

-Add/modify code

-Update documentation if needed

-Run tests before pushing

=Commit your changes

git commit -m "feat: add dashboard charts"

-Use Conventional Commits for clarity.

=Push to your fork

git push origin feature/your-feature\

-Open a Pull Request (PR)

-Go to the original repo: Polarix

-Open a PR from your forked branch

-Add a clear description of your changes

📖 Code of Conduct

Be respectful to all contributors

Write clean, maintainable code

Always document your changes

Help review PRs when possible

🛠 Development Setup

Backend (Node.js + Express)

cd backend
npm install
npm run dev

Runs on: http://localhost:5000

Frontend (HTML + CSS + javaScript)

Runs on: http://localhost:3000

🧪 Testing

Make sure all tests pass before raising a PR.

npm test

✅ Good First Issues

We label beginner-friendly tasks as good first issue.

Check them out here → Good First Issues

🎉 Hacktoberfest Contributions

This project is Hacktoberfest-eligible 🌍

Submit quality PRs

Avoid spam or irrelevant contributions

Help others by reviewing PRs