CONTRIBUTING.md

Contributing to Optimizely SaaS CMS + Next.js Masterclass

First off, thank you for considering contributing to our project! It's people like you that make this project such a great tool.

Table of Contents

1. Code of Conduct
2. Getting Started
   • Issues
   • Pull Requests
3. Setting Up the Development Environment
4. Coding Standards
5. Commit Message Guidelines
6. Branching Model
7. Testing
8. Building and Deploying
9. Managing Dependencies
10. Reporting Bugs
11. Suggesting Enhancements
12. Project Maintainers

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to project_email@example.com.

Getting Started

Issues

• Ensure the bug was not already reported by searching on GitHub under Issues.
• If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Pull Requests

1. Fork the repo and create your branch from main.
2. If you've added code that should be tested, add tests.
3. If you've changed APIs, update the documentation.
4. Ensure the test suite passes.
5. Make sure your code lints.
6. Issue that pull request!

Setting Up the Development Environment

1. Clone the repository:

git clone https://github.com/szymonuryga/Optimizely-Masterclass.git
cd Optimizely-Masterclass

2. Install dependencies:

npm install

3. Set up environment variables: Create a .env file in the root directory with the necessary variables (refer to the README for details).

4. Start the development server:

npm run dev

Coding Standards

We use ESLint and Prettier to ensure consistent code style. Our configuration files (.eslintrc.json and .prettierrc) are included in the repository.

• Run ESLint:

npm run lint

• Run Prettier:

npm run format

Please ensure your code adheres to these standards before submitting a pull request.

Commit Message Guidelines

We follow the Conventional Commits specification. This leads to more readable messages that are easy to follow when looking through the project history.

Example commit messages:

• feat(visual-builder): add new layout component
• fix(api): handle error in revalidation endpoint
• docs(readme): update deployment instructions

Branching Model

We use a simplified Gitflow workflow:

• main: The main branch where the source code always reflects a production-ready state.
• develop: The branch where features are integrated for the next release.
• Feature branches: Named feature/your-feature-name, branched off from and merged back into develop.
• Hotfix branches: Named hotfix/your-hotfix-name, branched off from main and merged into both main and develop.

Building and Deploying

To build the project:

npm run build

For deployment, we use Vercel. The main branch is automatically deployed to production, while feature branches are deployed to preview environments.

Managing Dependencies

We use npm for managing dependencies. To add a new dependency:

npm install package-name

For dev dependencies:

npm install --save-dev package-name

Please update the package.json file accordingly and commit the changes.

Reporting Bugs

When reporting bugs, please include:

1. A clear, descriptive title
2. A detailed description of the issue
3. Steps to reproduce the problem
4. Expected behavior
5. Actual behavior
6. Screenshots (if applicable)
7. Your environment (OS, browser, Node.js version, etc.)

Suggesting Enhancements

When suggesting enhancements, please include:

1. A clear, descriptive title
2. A detailed description of the proposed enhancement
3. Any potential implementation ideas you have
4. Why this enhancement would be useful to most users

Project Maintainers

• Szymon Uryga - Lead Developer

Thank you for contributing to our project!