Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (45 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

57 lines (45 loc) · 1.83 KB

Contributing to Gitfolio

First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to this project. These are mostly guidelines, not rules. Use your best judgment and feel free to propose changes to this document in a pull request.

🚀 Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally: 
    git clone https://github.com/your-username/gfbs3-portfolio-demo.git
cd gfbs3-portfolio-demo
  3. Install dependencies: 
    npm install
  4. Run the development server: 
    npm run dev
    Open http://localhost:3000 with your browser to see the result.

🛠️ Development Workflow

  1. Create a new branch for your feature or fix: 
    git checkout -b feature/amazing-feature
  2. Make your changes.
  3. Lint your code to ensure it meets the project's standards: 
    npm run lint
  4. Commit your changes with a descriptive message.

🎨 Style Guidelines

  • Aesthetic: Maintain the "Retro-Futuristic" / Cyberpunk 1985 vibe.
  • Tailwind CSS: Use utility classes for styling.
  • Colors: Stick to the defined palette (Cyan, Fuchsia, Yellow, Deep Space Black).
  • Typography: Use font-mono for text elements.

📬 Submitting a Pull Request

  1. Push your branch to your fork: 
    git push origin feature/amazing-feature
  2. Open a Pull Request on the original repository.
  3. Provide a clear description of the changes and why they are necessary.
  4. Wait for review!

🤝 Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Be kind and respectful to others.