Contributing to DOPE Social Media Network

Thank you for your interest in contributing to DOPE! This document outlines how you can contribute to our cross-platform social media network.

Table of Contents

• Code of Conduct
• Getting Started
• Development Workflow
• Pull Request Process
• Coding Standards
• Testing
• Documentation
• Issue Reporting
• Security Vulnerabilities
• Community

Code of Conduct

We are committed to providing a welcoming and inclusive experience for everyone. Please read our Code of Conduct before participating.

Getting Started

1. Fork the repository on GitLab
2. Clone your fork:

   git clone https://gitlab.com/rexluciano-group/dope-crossplatform.git
   cd dope-crossplatform

3. Set up the development environment:

   npm install  # or yarn install

4. Create a branch for your feature or bugfix:

   git checkout -b feature/your-feature-name

Development Workflow

1. Make your changes in your feature branch 2. Ensure your code follows our [coding standards](#coding-standards) 3. Add or update tests as necessary 4. Run the test suite to ensure everything passes 5. Update documentation if needed 6. Commit your changes with a descriptive message 7. Push your branch to your fork 8. Submit a pull request to the main repository

Pull Request Process

1. Ensure your PR description clearly describes the problem and solution
2. Include the relevant issue number if applicable
3. Update the README.md or documentation with details of changes if needed
4. The PR must pass all CI/CD checks before being merged
5. A maintainer will review your PR and may request changes
6. Once approved, a maintainer will merge your PR

Coding Standards

• Follow the existing code style in the project - Use meaningful variable and function names - Write comments for complex logic - Keep functions small and focused
• For frontend:
• Follow component structure guidelines
• Use proper state management patterns
• For backend:
• Follow RESTful API design principles
• Implement proper error handling

Testing

• Write tests for all new features and bug fixes
• Ensure all tests pass before submitting a PR
• Frontend: Write component tests and integration tests
• Backend: Write unit tests and API tests
• Run tests with:

   npm test  # or yarn test

Documentation

• Update documentation for any changed functionality
• Document new features thoroughly
• Use JSDoc comments for functions and methods
• Keep API documentation up to date

Issue Reporting

• Use the issue tracker to report bugs
• Before creating a new issue, please check if it already exists
• Include detailed steps to reproduce the issue
• Specify your environment (OS, browser, version)
• For feature requests, clearly describe the problem and potential solution

Security Vulnerabilities

If you discover a security vulnerability, please do NOT open an issue. Email security@dopp.eu.org instead.

Community

• Join our Discord server for discussions
• Follow our blog for updates
• Attend our monthly community calls

Thank you for contributing to DOPE Cross-Platform Social Media Network!

Would you like more details about any specific section of the contributing guidelines?