Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lightlessdays authored Oct 15, 2023
1 parent 72cff12 commit fbf4bd4
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Contributing to the Patria AR

Welcome to the Patria AR project! We're thrilled that you're interested in contributing to our open-source search engine. This document outlines how you can get involved and make meaningful contributions to our project.

## How Can I Contribute?

There are several ways you can contribute to the Patria AR project:

### 1. Code Contributions

If you have coding skills and want to contribute to the development of Patria AR, you can:

- Fork the repository.
- Create a new branch for your feature or bug fix: `git checkout -b feature/your-feature-name` or `git checkout -b bugfix/your-bugfix-name`.
- Make your changes, write code, and test thoroughly.
- Commit your changes: `git commit -m "Description of your changes"`.
- Push your changes to your fork: `git push origin feature/your-feature-name` or `git push origin bugfix/your-bugfix-name`.
- Open a pull request (PR) to the `main` branch of this repository.

Please ensure that your code follows our coding standards and practices, and include clear and concise commit messages and PR descriptions.

### 2. Documentation Contributions

Good documentation is crucial for our project's success. You can help by:

- Improving existing documentation.
- Adding documentation for features or functions that are lacking.
- Correcting typos, grammar, and formatting issues.

You can make documentation contributions by following the same fork and pull request process mentioned above, but targeting the `documentation` branch or mentioning that it's a documentation update in your PR description.

### 3. Issue Reporting

If you come across a bug or have a feature request, please open an issue on our [Issue Tracker](https://github.com/lightlessdays/Patria-AR/issues). Provide as much detail as possible to help us understand and address the problem or request.

## Code of Conduct

Before contributing, please review our [Code of Conduct](CODE_OF_CONDUCT.md) to ensure a respectful and inclusive environment for all community members.

## Licensing

By contributing to the Patria AR project, you agree that your contributions will be licensed under the project's [LICENSE](LICENSE.md). Please read the license carefully.

Thank you for contributing to the Patria AR project! We appreciate your support and look forward to your contributions.

0 comments on commit fbf4bd4

Please sign in to comment.