Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 1.96 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 1.96 KB
Raw

Frontend Contributing Guidelines 💻

Thank you for considering contributing to our project! Here are some guidelines to ensure smooth collaboration.

File Naming Convention 📁

  • All React component files should be named in Pascal case (e.g., MyComponent).
  • React component functions should also be named in Pascal case (e.g., function MyComponent() {}).
  • Folders should be named in camel case (e.g., peopleData).
  • Typescript files should follow camel case.
  • Only the index.tsx files should be named in lowercase.

Prettier Fixing 🛠️

  • Run the following command to fix Prettier errors before submitting: 
    yarn run prettier

Eslint Fixing 🚨

  • Run the following command to fix ESLint issues and ensure all test cases pass: 
    yarn run eslint

Getting Started 🚀

  1. Fork the repository.
  2. Create a new branch for your contribution: 
    git checkout -b feature/your-feature
  3. Make your changes.
  4. Commit your changes: 
    git commit -m "Add your meaningful commit message"
  5. Push to your fork: 
    git push origin feature/your-feature
  6. Open a pull request to the main branch of the original repository.

Code Review ⚙️

All code contributions, including those with commit access, must go through a pull request and be approved by a core developer before being merged. This ensures a proper review of all the code.

About Sphinx Bounties 💬

A Unique bounty platform that rewards in Bitcoin. Join Sphinx Chat, accomplish a bounty, and start earning Bitcoin! Explore our website for a list of available bounties.

Thank You ❤️

We appreciate your contribution to our project! Your efforts make a difference, and we look forward to collaborating with you.

Feel free to connect with us on our Sphinx Community and follow us on Twitter for updates.