Skip to content

Latest commit

 

History

History
54 lines (34 loc) · 2.57 KB

CONTRIBUTING.md

File metadata and controls

54 lines (34 loc) · 2.57 KB
Raw

Contributing to Code Explorer

First off, thank you for considering contributing to Code Explorer! We're excited to have you on board.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Code of Conduct

This project and everyone participating in it is governed by the Code Explorer Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainers.

How Can I Contribute?

Reporting Bugs

If you find a bug in Code Explorer, please open an issue on the GitHub issue tracker. Be sure to include a clear title and description of the problem, as well as any relevant details such as the version of Code Explorer you're using.

Suggesting Enhancements

If you have an idea for a new feature or improvement to Code Explorer, please open an issue on the GitHub issue tracker. Be sure to provide a clear title and description of your suggestion, as well as any relevant details or examples.

Pull Requests

If you'd like to contribute code to Code Explorer, please follow these steps:

  1. Fork the repository and create a new branch for your changes.
  2. Make your changes and ensure that your code is well-formatted and follows the project's coding style guidelines.
  3. Write clear and concise commit messages that describe your changes.
  4. Open a pull request on the GitHub repository and provide a clear title and description of your changes.
  5. Wait for feedback from the project maintainers and make any necessary adjustments.
  6. Once your pull request is approved, it will be merged into the main branch.

Styleguides

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 using the # symbol

Python Code

  • Follow the PEP 8 style guide
  • Use 4 spaces per indentation level
  • Use blank lines to separate functions and classes, and larger blocks of code inside functions
  • Add comments to explain complex sections of code

Documentation

  • Use Markdown for documentation
  • Keep documentation up-to-date with any changes to the code
  • Use clear and concise language

Thank you for your interest in contributing to Code Explorer! We're excited to see what you can bring to the project.