Skip to content

Latest commit

 

History

History
75 lines (51 loc) · 5.22 KB

CONTRIBUTING.md

File metadata and controls

75 lines (51 loc) · 5.22 KB
Raw

Contributing to the Chartboost Mediation

We value each contribution provided by the community and strive to achieve the following goals for the most optimal contribution experience:

  • Maintain the adapter's quality.
  • Fix problems that are important to users.
  • Enable a sustainable system for the adapter's maintainers to review contributions.

Therefore, this document will note specific steps and details required for you to contribute.

How Can I Contribute?

There are two ways to contribute:

Reporting Bugs

Bugs are tracked as a type of GitHub issues. To submit a report, create an issue and provide the information instructed in the template.

Note: If you find a Closed issue that seems similar to what you're experiencing, open a new issue and include a link to the closed issue.

Follow these guides to create a detailed and effective report for us to understand and resolve issues faster:

  • Use a clear, concise, and descriptive title for the issue that identifies the problem.
  • Describe the steps with as much concise detail as possible to reproduce the problem. For example, start by explaining how the Chartboost Mediation ad object was created and the method calls invoked on the object.
  • Provide specific examples to demonstrate each step. Include links to files, screenshots, Charles logs, or copy/pasteable code snippets used in those examples. Use markdown code blocks when providing snippets.
  • Describe the behavior(s) observed and explain why that behavior is a problem.
  • Describe the behavior(s) expected.
  • Include screenshots and animated GIFs of the described steps and behaviors that demonstrate the problem.
  • If you're reporting a crash, include the crash report with a stack trace and in the issue using either a code block, file attachment, or gist link.
  • If the problem is related to performance or memory, include a CPU profile capture.
  • If the problem wasn't triggered by a specific action, describe what you were doing before the problem happened.

Pull Requests

In order to submit pull requests, you are required to review and sign the Contribution License Agreement (CLA) which is available on the Chartboost website to view. Once you have read the agreement, sign the appropriate form depending on whether you are an individual an employer contributor.

Submitting a Pull Request

Follow these steps to have your contribution considered by the maintainers:

  1. Review and sign the Contribution License Agreement (CLA).
  2. Identify the issue related to your fix. If an issue doesn't exist, then create a new issue.
  3. Create a pull request.
  4. Format the title starting with the issue number, followed by a brief description of the fox. Example: [ISSUE-60] Fix null pointer exception.
  5. Follow the style guides in your pull request.
  6. Submit your pull request.
  7. Verify that all status checks are passing. If a status check is failing and you believe that the failure is unrelated to your change, then leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check. If we conclude that the failure was a false positive, then we will open an issue to track the problem with our status check suite.

While the prerequisites above must be satisfied before your pull request is reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be accepted.

Style Guides

Git 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

Kotlin

Follow the Android developers Kotlin style guide.

Swift

Follow Google's Swift style guide.

C#

Follow Microsoft's C# coding conventions guide.