Skip to content
Crisp

Contributor Guidelines

Crisp is a Free and Open Source Software (FOSS), hence we welcome contributions from everyone and aim to make this project a positive and collaborative space for everyone involved with it.

Please take a moment to review the following guidelines to ensure that we can process your contribution quickly and effectively.

How to Contribute

Reporting Issues

If you encounter any bugs or issues, please follow these steps to report them:

  1. Search existing issues: Before opening a new issue, please search through the issues to ensure that your issue has not been reported yet.
  2. Provide detailed information: When reporting an issue, be as descriptive as possible. Include information such as:
    • Steps to reproduce the issue.
    • Expected vs. actual behavior.
    • Any error messages you encountered.
    • Your environment (OS, version of the project, dependencies, etc.).

Suggesting Enhancements

If you have an idea for an enhancement or feature, please:

  1. Search existing issues: Make sure the feature request has not already been suggested.
  2. Describe the enhancement clearly: Provide as much context as possible, such as:
    • The problem you’re trying to solve.
    • Why this enhancement would be valuable.
    • Any possible solutions or approaches you suggest.

Making a Pull Request

We welcome contributions through Pull Requests on our GitHub repository here - Weburz/crisp! To ensure that your Pull Request is merged smoothly, please follow these steps:

  1. Fork the repository: Start by forking the repository to your own GitHub account.
  2. Clone your fork: Clone your fork to your local machine using git clone.
  3. Create a branch: Create a new branch for your changes with a descriptive name. For example:
    Terminal window
    git switch --create feature/your-feature-name
  4. Make your changes: Make the necessary changes in the code, ensuring that you follow the style guide and the overall structure of the project.
  5. Test your changes: Run any relevant tests to ensure that your changes do not break existing functionality.
  6. Commit your changes: Write clear, concise commit messages. Please refer to the Conventional Commits specifications for guidance.
  7. Push your changes: Push your changes to your fork:
    Terminal window
    git push origin feature/your-feature-name
  8. Open a pull request: Go to the repository and open a pull request to the main branch. Be sure to:
    • Provide a clear description of what you have done.
    • Reference any related issues or feature requests.
    • Indicate if you have tested your changes.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. We are committed to creating a welcoming and inclusive environment for everyone.

Development Process

Please refer to the Development Process guidelines for reference on developing Crisp.

Style Guide

We follow certain coding styles to ensure consistency across the codebase. Please adhere to the following guidelines:

  • Code format: Use consistent indentation (e.g., a single tab for indentation).
  • Naming conventions: Use descriptive names for variables, functions, and classes.
  • Documentation: Ensure that your code is well-documented. Use docstrings or comments to explain complex logic.
  • Commit messages: Follow the Conventional Commits specifications for writing well descriptive commit messages.

License

By contributing to this project, you agree that your contributions will be licensed under the MIT License.

Thank you again for your interest in contributing! We appreciate your help in making this project better.