Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
239 lines (158 loc) · 3.75 KB

CONTRIBUTING.md

File metadata and controls

239 lines (158 loc) · 3.75 KB
Raw

🚀 Contributing to SpectraX

First off, thank you for considering contributing to SpectraX!
We truly appreciate your time and effort in helping improve the project.

SpectraX is proudly participating in GirlScript Summer of Code 2026 (GSSoC'26) 💙

🌟 GSSoC'26 Contribution Guidelines

📌 Issue Assignment

  • Browse available issues from the Issues section.
  • Comment on the issue you want to work on.
  • Wait until a maintainer assigns the issue to you before starting work.

Example:

I would like to work on this issue under GSSoC'26.
Please assign it to me.

🏷️ Issue Labels

Common labels used in this repository:

Label Meaning
gssoc-26 GSSoC contribution issue
good first issue Beginner-friendly issue
bug Bug fixes
enhancement Feature improvements
documentation Documentation-related tasks

🛠️ Project Setup

1️⃣ Fork the Repository

Click the Fork button on the top-right corner of this repository.

2️⃣ Clone Your Fork

git clone https://github.com/YOUR_USERNAME/spectrax_1.git
cd spectrax_1

3️⃣ Create a New Branch

Always create a separate branch for your work.

git checkout -b feature/your-feature-name

📌 Branch Naming Conventions

Prefix Usage
feature/ New features
bugfix/ Bug fixes
docs/ Documentation updates
refactor/ Code refactoring
test/ Adding tests

Examples:

feature/add-dark-mode
bugfix/fix-navbar-overlap
docs/update-contributing-guide

📦 Install Dependencies

Frontend

npm install

Backend

cd server
npm install
cd ..

▶️ Running the Project

Start Frontend

npm run dev

Start Backend

cd server
npm start

💬 Commit Message Guidelines

Use meaningful commit messages.

Recommended Format

Prefix Purpose
feat: New feature
fix: Bug fix
docs: Documentation
style: UI/Formatting
refactor: Code restructuring
test: Testing

✅ Examples

feat: add dark mode support
fix: resolve navbar alignment issue
docs: update installation instructions

🧪 Testing Instructions

Before submitting your PR:

Run Lint Checks

npm run lint

Build Project

npm run build

Manual Testing

  • Test your feature locally
  • Check browser responsiveness
  • Ensure there are no console errors

🎨 Code Style Guidelines

Please follow these practices:

  • Use Prettier for formatting
  • Follow ESLint rules
  • Write clean and readable code
  • Prefer reusable components
  • Use React functional components and hooks
  • Avoid unnecessary dependencies

🔄 Pull Request Process

Before Creating PR

Make sure:

  • Your branch is updated
  • Code is tested locally
  • Documentation is updated if needed

Creating Pull Request

  1. Push your branch to GitHub
git push origin your-branch-name
  1. Open a Pull Request
  2. Link the issue number in PR description

Example:

Fixes #123
  1. Add screenshots/videos for UI changes

🛡️ Contribution Rules

To maintain quality contributions:

  • PRs without linked issues may be closed
  • Spam or low-quality PRs will not be accepted
  • Avoid unnecessary file changes
  • Follow repository structure properly

🤝 Need Help?

If you face setup issues or need guidance:

  • Open a discussion
  • Ask in issue comments
  • Reach out to maintainers politely

We are happy to help contributors learn and grow 🌱

❤️ Thank You

Thank you for contributing to SpectraX and being part of the open-source community.

Happy Coding! 🚀