Skip to content

Latest commit

 

History

History
45 lines (43 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

45 lines (43 loc) · 2.7 KB
Raw

CONTRIBUTING.md

Introduction

Thank you for considering contributing to the Jentalk IDE! This document provides guidelines for contributing to this project. By participating, you are expected to uphold this code.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the issue tracker to ensure the bug has not already been reported. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When suggesting an enhancement, include:

  • A clear and descriptive title.
  • A detailed explanation of the expected behavior and why you believe it would be beneficial.
  • Any relevant examples or mockups.

Pull Requests

Follow these steps for contributing:

  1. Fork the repository.
  2. Clone your fork and create a new branch from main.
  3. Make your changes and test them thoroughly.
  4. Commit your changes with a clear and descriptive commit message.
  5. Push your changes to your fork on GitHub.
  6. Submit a pull request to the original repository.

Pull Request Checklist

  • Ensure the PR description clearly describes the problem and solution.
  • Include the relevant issue number if applicable.
  • Update the README.md with details of changes to the interface, new environment variables, exposed ports, useful file locations, and container parameters.

Code of Conduct

  • Respect the Jentalk community and other contributors.
  • Refrain from demeaning, discriminatory, or harassing behavior and speech.
  • Be open to collaboration and constructive feedback.

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 liberally after the first line.

Python Styleguide

  • Follow the PEP 8 style guide for Python code.
  • Use docstrings to explain code functionality.

Documentation Styleguide

  • Use Markdown for documentation.
  • Keep documentation up-to-date with changes to the codebase.

License

By contributing to the Jentalk IDE, you agree that your contributions will be licensed under its GNU GPLv3 License.

Acknowledgments

Your contributions are deeply appreciated and will help make the Jentalk IDE a more robust and feature-rich tool for everyone. Together, we can push the boundaries of what's possible in the realm of software development and linguistic expression.