Skip to content

Latest commit

 

History

History
71 lines (45 loc) · 3.62 KB

CONTRIBUTING.md

File metadata and controls

71 lines (45 loc) · 3.62 KB
Raw

Contributing to Artado Search

Welcome to the Artado Search project! We're excited that you're interested in contributing to our search engine platform. By following these guidelines, you can help us create a collaborative environment for developers to build themes, extensions, and translations, enhancing the search experience for users.

Table of Contents

Code of Conduct

Before you start contributing, please read and adhere to our Code of Conduct. This ensures a respectful and inclusive environment for all participants.

How Can I Contribute?

There are multiple ways you can contribute to the Artado Search project:

  • Reporting Issues: Help us identify bugs, suggest enhancements, or report issues you come across.
  • Submitting Pull Requests: Contribute directly to the codebase by adding features or fixing bugs.
  • Creating Themes and Extensions: Customize the search engine's appearance and functionality through themes and extensions.
  • Translating Artado Search: Contribute translations or correct existing ones to make the platform more accessible.
  • Documentation: Improve existing guides or create new ones to assist developers and users.

Reporting Issues

If you encounter a bug, have a suggestion, or wish to report an issue:

  1. Check the existing issues to make sure it hasn't already been reported.
  2. If it's a new issue, create a new issue with a clear title and detailed description.
  3. Include relevant information, like screenshots or error messages, if applicable.

Submitting Pull Requests

Before submitting a pull request, ensure your changes adhere to our guidelines and relate to a specific issue or enhancement.

  1. Fork the repository and create a new branch for your changes.
  2. Implement your changes, following coding guidelines and testing them locally.
  3. Push your changes to your forked repository.
  4. Open a pull request from your branch to the main repository's main branch.

Creating Themes and Extensions

Dive into our platform's extensibility by crafting themes and extensions to personalize the search experience. Visit the Theme and Extension Documentation for comprehensive guidelines on creating and publishing your customizations.

Translating Artado Search

Contributions to translations are crucial for making Artado Search more inclusive. To contribute translations or improve existing ones:

  1. Follow the Translation Documentation for guidance on adding new languages or refining translations.

Community

Connect with our community of developers and users to share insights, discuss enhancements, and collaborate on projects:

License

By contributing to the Artado Search project, you agree that your contributions will be licensed under the GNU Affero General Public License v3.0.

Thank you for considering contributing to the Artado Search project. Your contributions play a vital role in creating a flexible and user-friendly search engine for everyone.