Contributing to c3-components

July 6, 2024 ยท View on GitHub

First of all, thank you for your interest in contributing to the c3-components project! We appreciate your effort and look forward to collaborating with you. This document provides guidelines and best practices for contributing to the project.

Table of Contents

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct. Please take a moment to read it before contributing.

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork of the repository to your local machine.
  3. Install the required dependencies with npm install.
  4. Create a new branch for your changes using git checkout -b your-feature-branch.
  5. Implement your changes, following the coding style and testing guidelines.
  6. Commit your changes and push them to your fork on GitHub.
  7. Create a pull request with a clear description of your changes.

Reporting Issues

If you encounter any issues or bugs, please report them on the issue tracker. When submitting an issue, make sure to:

  • Use a clear and descriptive title.
  • Provide a detailed description of the issue and steps to reproduce it.
  • Include any relevant code snippets or screenshots.

Submitting Pull Requests

When submitting a pull request, please follow these guidelines:

  • Use a clear and descriptive title.
  • Provide a detailed description of your changes.
  • Reference any related issues in the pull request description.
  • Make sure your changes follow the coding style and testing guidelines.
  • Update the documentation if necessary.

Coding Style

To ensure consistency and readability, please adhere to the following coding style guidelines:

  • Use 2 spaces for indentation.
  • Follow the Angular style guide.
  • Use camelCase for variable and function names.
  • Use PascalCase for class names.
  • Add comments to explain complex or non-obvious code.
  • Break down long functions or classes into smaller, more manageable pieces.

Testing

Before submitting a pull request, make sure to test your changes thoroughly. Follow these testing guidelines:

  • Write unit tests for new features and bug fixes.
  • Ensure all tests pass by running ng test.
  • Test your changes in multiple browsers and screen sizes.

Documentation

Keep the documentation up-to-date by following these guidelines:

  • Update the README.md file if you add or change any functionality.
  • Document any new components or features in the documentation website.
  • Use clear and concise language, and provide examples when possible.

Additional Resources

Once again, thank you for your interest in contributing to the c3-components project. Your time and expertise are greatly appreciated!