Open Collective Docs
Go back to Open Collective
Search…
Welcome
About
Introduction
Documentation
Terminology
Company
Pricing
Team
The Open Collective Way
Investors
Contributing
Product
Features
Roadmap
Comparison
User Profile
Currencies
Log-in System
Privacy Policy
Moderation
Security
Collectives
Collectives FAQ
Creating a Collective
Quick Start Guide
Collective Settings
Add Fiscal Host
Change Fiscal Host
Open Source Collectives
Transparent Budget
Expenses
Updates & Comms
Moderation
Conversations
Events
Projects
Funding Options
Buttons & Banners
Connected Collectives
Embed contribution flow
Financial Contributors
Financial Contributors FAQ
Guest contributions
Payments
Crypto Contributions
Website Badge
Receipts
Collective to Collective
Organizations
Expenses & Getting Paid
Expenses FAQ
Submitting Expenses
Virtual Cards
Expense Comments
Edit or Download an Expense
Tax Information
Fiscal Hosts
Fiscal Hosts FAQ
Becoming a Fiscal Host
Creating a Fiscal Host
Fiscal Host Settings
Payouts
Fiscal Host Dashboard
Bank Transfers
Virtual Card Settings
Add Funds Manually
Refunds
Host Fees
Local Tax Support
Agreement Templates
Independent Collectives
About Independent Collectives
Create an Independent Collective
Independent Collective Setup
Independent Collective Management
Close an Independent Collective
Contributing
Design
Development
Contribution Guide
Best Practice Guidelines
Bounties
Architecture
API
README Integration
PayPal
TransferWise
Post-Donation Redirect
Manual Reporting
GitHub Permissions
Internationalization (i18n) system
Testing with Cypress
Testing features
Collective's locations
Virtual Cards
Documentation
Translation
Powered By GitBook
Best Practice Guidelines
Describes what we expect from new code. Also includes special tips to help you getting started!

General rules

  • When adding new dependencies, we use fixed versions.
  • Don't commit package-lock.json if you're not making any changes to the libraries.
  • If the issue you're working on requires changes in both API and Frontend, give your Git branches the same name. CI will automatically pull the correct API's branch when testing the Frontend.
  • We love screenshots - or better: screencasts. Include some in your pull requests to demonstrate your changes and you will have our eternal gratitude.

Frontend rules

  • I18n
    • The strings must be internationalized. See /help/developers/translations.
    • Update the language files npm run build:langs and commit them to reflect the changes.
  • Libraries
    • Whenever it's possible, we must use styled-components to write styles. See OC Styleguide.​
    • We're getting rid of material-ui. We still rely on this library for some stuff but please don't use it directly.
    • Icons must be imported from the styled-icons library.
  • Testing
    • Tests written with Cypress must follow our good practices conventions.
Previous
Contribution Guide
Next
Bounties
Last modified 7mo ago
Export as PDF
Copy link
Contents
General rules
Frontend rules