Skip to content

Latest commit

 

History

History
47 lines (31 loc) · 2.11 KB

CONTRIBUTING.md

File metadata and controls

47 lines (31 loc) · 2.11 KB

Contributing Guidelines

Thank you for your interest in contributing to Intento documentation! We welcome contributions from the community to help improve the Intento documentation and make it even better. Before you get started, please take a moment to review the following guidelines.

Getting Started

To contribute to Intento documentation, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your contribution.
  3. Make your changes or additions.
  4. Test your changes to ensure they work as expected.
  5. Commit your changes and push them to your forked repository.
  6. Submit a pull request to our main repository.

Code Style

We follow a specific code style in Intento documentation to maintain consistency and readability. Please make sure to adhere to the following guidelines:

  • Use meaningful variable and function names.
  • Indent code using spaces, not tabs. Use prettier to format your code if possible.
  • Use proper commenting to explain complex logic or algorithms.
  • Follow the naming conventions for files, classes, functions, and variables.

Reporting Issues

If you encounter any issues or bugs while using Intento documentation, please report them by following these steps:

  1. Check if the issue has already been reported by searching our issue tracker.
  2. If the issue hasn't been reported, create a new issue and provide a detailed description of the problem.
  3. Include steps to reproduce the issue and any relevant error messages or screenshots.

Pull Request Guidelines

When submitting a pull request, please ensure the following:

  1. Provide a clear and descriptive title for your pull request.
  2. Include a detailed description of the changes you have made.
  3. Reference any related issues or pull requests.
  4. Make sure your code passes all tests and doesn't introduce any new issues.
  5. Keep your pull request focused on a single feature or bug fix.

Code of Conduct

We expect all contributors to adhere to our code of conduct. Please review our Code of Conduct before contributing.

Thank you for your contributions and helping us improve Intento documentation!