Skip to content

Latest commit

 

History

History
100 lines (74 loc) · 3.89 KB

CONTRIBUTING.md

File metadata and controls

100 lines (74 loc) · 3.89 KB

Contributing to Safe Deal - Browser

We welcome contributions to the Safe Deal - Browser project! This document provides guidelines for contributing to the project. By participating in this project, you agree to abide by its terms.

Table of Contents

  1. Code of Conduct
  2. Getting Started
  3. How to Contribute
  4. Style Guidelines
  5. Commit Messages
  6. Pull Requests
  7. Reporting Bugs
  8. Suggesting Enhancements
  9. License

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 [INSERT EMAIL].

Getting Started

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Set up the development environment as described in the README.md file.
  4. Create a new branch for your contribution.

How to Contribute

  1. Ensure your code adheres to the project's coding standards.
  2. Add or update tests as necessary.
  3. Update documentation as needed.
  4. Run the test suite and ensure all tests pass.
  5. Push your changes to your fork.
  6. Submit a pull request to the main repository.

Style Guidelines

  • Follow the Chromium coding style for C++ code.
  • Use 2 spaces for indentation.
  • Keep lines under 80 characters when possible.
  • Use meaningful variable and function names.
  • Comment your code where necessary.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Pull Requests

  1. Fill in the required template.
  2. Do not include issue numbers in the PR title.
  3. Include screenshots and animated GIFs in your pull request whenever possible.
  4. Follow the Chromium CLA signing process.
  5. End all files with a newline.

Reporting Bugs

  1. Use the bug report template to create the issue.
  2. Include detailed steps to reproduce the issue.
  3. Include screenshots if applicable.
  4. Describe the expected behavior and the actual behavior.
  5. Include details about your environment (OS, browser version, etc.).

Suggesting Enhancements

  1. Use the feature request template to create the issue.
  2. Provide a clear and detailed explanation of the feature you want to see.
  3. Provide examples to demonstrate the steps or the end result.
  4. Explain why this enhancement would be useful to most Safe Deal - Browser users.

Working with Chromium Submodule

When making changes that affect the Chromium codebase:

  1. Ensure you're working in the chromium/src directory.
  2. Make your changes in a separate branch.
  3. Test your changes thoroughly.
  4. Submit a pull request to the Chromium project on GitHub following their contribution guidelines.
  5. Once your pull request is accepted and merged, update the Chromium submodule in the Safe Deal - Browser repository.

License

By contributing to Safe Deal - Browser, you agree that your contributions will be licensed under its Apache License 2.0. This is the same license that covers the project and ensures that all contributions have the same open-source protections. For more details, see the LICENSE file.

Additional Resources