-
Notifications
You must be signed in to change notification settings - Fork 560
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' of https://github.com/3dwesupport/OpenBot into …
…android-vehicle-control
- Loading branch information
Showing
690 changed files
with
54,179 additions
and
1,620 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -16,4 +16,4 @@ wandb/ | |
|
||
# build | ||
/bin | ||
|
||
/node_modules/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Beitrag leisten | ||
|
||
<p align="center"> | ||
<a href="CONTRIBUTING.md">English</a> | | ||
<a href="CONTRIBUTING.zh-CN.md">简体中文</a> | | ||
<span>Deutsch</span> | | ||
<a href="CONTRIBUTING.fr-FR.md">Français</a> | | ||
<a href="CONTRIBUTING.es-ES.md">Español</a> | ||
</p> | ||
|
||
## Prozess | ||
|
||
1. Reichen Sie ein Issue ein, in dem Sie die Änderungen beschreiben, die Sie implementieren möchten. Wenn es sich nur um kleinere Änderungen/Fehlerbehebungen handelt, können Sie direkt zu Schritt 3 springen. | ||
2. Nachdem der Umfang im Issue besprochen wurde, weisen Sie es sich selbst zu. Es sollte in der Spalte "To do" im OpenBot-Projekt erscheinen. | ||
3. Forken Sie das Projekt und klonen Sie es lokal: | ||
|
||
`git clone https://github.com/<user_id>/OpenBot.git` | ||
|
||
4. Erstellen Sie einen Branch: | ||
|
||
`git checkout -b <branch-name>` | ||
|
||
wobei `<branch-name>` den Umfang der Arbeit prägnant beschreibt. | ||
|
||
5. Erledigen Sie die Arbeit, schreiben Sie gute Commit-Nachrichten und pushen Sie Ihren Branch in das geforkte Repository: | ||
|
||
```bash | ||
git add <geänderte Datei> | ||
git commit -m <aussagekräftige Beschreibung> | ||
git push --set-upstream origin <branch-name> | ||
``` | ||
|
||
6. Erstellen Sie eine [Pull-Anfrage](https://github.com/intel-isl/OpenBot/pulls) auf GitHub und verlinken Sie das Issue damit. Es sollte in der Spalte "In progress" im OpenBot-Projekt erscheinen. | ||
7. Arbeiten Sie an jedem Code-Review-Feedback, das Sie erhalten, und pushen Sie es in Ihr Fork. Die Pull-Anfrage wird automatisch aktualisiert. | ||
8. Gönnen Sie sich ein kaltes Getränk Ihrer Wahl, um sich dafür zu belohnen, die Welt ein Stück besser gemacht zu haben. | ||
|
||
## Richtlinien | ||
|
||
- Verwenden Sie denselben Stil und dieselbe Formatierung wie der Rest des Codes. | ||
- Für den Java (Android)- und Python-Code siehe [unten](#Formatierung). | ||
- Für jeden anderen Code versuchen Sie einfach, sich anzupassen. | ||
- Aktualisieren Sie die Dokumentation, die mit den von Ihnen vorgenommenen Codeänderungen verbunden ist. | ||
- Wenn Sie Drittanbieter-Abhängigkeiten einbeziehen möchten, besprechen Sie dies bitte zuerst im Issue. | ||
- Pull-Anfragen sollten einzelne Funktionen mit so wenigen Änderungen wie möglich implementieren. | ||
- Stellen Sie sicher, dass Sie keine temporären oder Binärdateien einbeziehen (die .gitignore-Dateien sollten dies größtenteils erledigen). | ||
- Rebasen/Mergen Sie den Master in Ihren Branch, bevor Sie die Pull-Anfrage einreichen. | ||
- Testen Sie Ihren Code nach Möglichkeit unter Windows, Linux und OSX. | ||
|
||
## Formatierung | ||
|
||
### Java | ||
|
||
Wir verwenden ein Gradle-Skript zur Formatierung von Java-Code. Stellen Sie sicher, dass Sie sich im Verzeichnis `android` befinden. | ||
|
||
Sie können Ihren Code überprüfen mit: | ||
|
||
```bash | ||
./gradlew checkStyle | ||
``` | ||
|
||
Sie können den Stil auf alle Dateien anwenden, indem Sie ausführen: | ||
|
||
```bash | ||
./gradlew applyStyle | ||
``` | ||
|
||
### Python | ||
|
||
Wir verwenden [black](https://pypi.org/project/black/) zur Formatierung von Python-Code. | ||
|
||
Sie können Ihren Code im aktuellen Verzeichnis überprüfen mit: | ||
|
||
```bash | ||
black --check . | ||
``` | ||
|
||
Sie können den Stil auf alle Dateien im aktuellen Verzeichnis anwenden, indem Sie ausführen: | ||
|
||
```bash | ||
black . | ||
``` | ||
|
||
## Weitere Ressourcen | ||
|
||
Wenn Sie nach weiteren Informationen zum Beitrag zu Open-Source-Projekten suchen, sind hier zwei gute Referenzen: | ||
|
||
- [How to Contribute to Open Source](http://opensource.guide/how-to-contribute/) | ||
- [The beginner's guide to contributing to a GitHub project](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) | ||
|
||
Vielen Dank! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Contribuyendo | ||
|
||
<p align="center"> | ||
<a href="CONTRIBUTING.md">English</a> | | ||
<a href="CONTRIBUTING.zh-CN.md">简体中文</a> | | ||
<a href="CONTRIBUTING.de-DE.md">Deutsch</a> | | ||
<a href="CONTRIBUTING.fr-FR.md">Français</a> | | ||
<span>Español</span> | ||
</p> | ||
|
||
## Proceso | ||
|
||
1. Envía un issue describiendo los cambios que deseas implementar. Si son solo cambios menores/correcciones de errores, puedes saltar al paso 3. | ||
2. Después de discutir el alcance en el issue, asígnatelo a ti mismo. Debería aparecer en la columna "To do" en el proyecto OpenBot. | ||
3. Haz un fork del proyecto y clónalo localmente: | ||
|
||
`git clone https://github.com/<user_id>/OpenBot.git` | ||
|
||
4. Crea una rama: | ||
|
||
`git checkout -b <nombre-de-la-rama>` | ||
|
||
donde `<nombre-de-la-rama>` describe concisamente el alcance del trabajo. | ||
|
||
5. Realiza el trabajo, escribe buenos mensajes de commit, empuja tu rama al repositorio bifurcado: | ||
|
||
```bash | ||
git add <archivo modificado> | ||
git commit -m <descripción significativa> | ||
git push --set-upstream origin <nombre-de-la-rama> | ||
``` | ||
|
||
6. Crea una [pull request](https://github.com/intel-isl/OpenBot/pulls) en GitHub y enlaza el issue a ella. Debería aparecer en la columna "In progress" en el proyecto OpenBot. | ||
7. Trabaja en cualquier comentario de revisión de código que puedas recibir y empújalo a tu fork. La pull request se actualiza automáticamente. | ||
8. Tómate una bebida fría de tu elección para recompensarte por hacer del mundo un lugar mejor. | ||
|
||
## Directrices | ||
|
||
- Usa el mismo estilo y formato que el resto del código. | ||
- Para el código Java (Android) y Python, consulta [abajo](#Formatting). | ||
- Para cualquier otro código, solo intenta integrarte. | ||
- Actualiza la documentación asociada con los cambios de código que realizaste. | ||
- Si deseas incluir dependencias de terceros, por favor discútelo primero en el issue. | ||
- Las pull requests deben implementar características individuales con la menor cantidad de cambios posible. | ||
- Asegúrate de no incluir archivos temporales o binarios (los gitignores deberían encargarse de esto en su mayoría). | ||
- Rebase/merge master en tu rama antes de enviar la pull request. | ||
- Si es posible, prueba tu código en Windows, Linux y OSX. | ||
|
||
## Formateo | ||
|
||
### Java | ||
|
||
Usamos un script de gradle para formatear el código java. Asegúrate de estar en el directorio `android`. | ||
|
||
Puedes verificar tu código con: | ||
|
||
```bash | ||
./gradlew checkStyle | ||
``` | ||
|
||
Puedes aplicar el estilo a todos los archivos ejecutando: | ||
|
||
```bash | ||
./gradlew applyStyle | ||
``` | ||
|
||
### Python | ||
|
||
Usamos [black](https://pypi.org/project/black/) para formatear el código python. | ||
|
||
Puedes verificar tu código en el directorio actual con: | ||
|
||
```bash | ||
black --check . | ||
``` | ||
|
||
Puedes aplicar el estilo a todos los archivos en el directorio actual ejecutando: | ||
|
||
```bash | ||
black . | ||
``` | ||
|
||
## Recursos adicionales | ||
|
||
Si estás buscando más información sobre cómo contribuir a proyectos de código abierto, aquí tienes dos buenas referencias: | ||
|
||
- [How to Contribute to Open Source](http://opensource.guide/how-to-contribute/) | ||
- [The beginner's guide to contributing to a GitHub project](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) | ||
|
||
¡Muchas gracias! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# Contribuer | ||
|
||
<p align="center"> | ||
<a href="CONTRIBUTING.md">English</a> | | ||
<a href="CONTRIBUTING.zh-CN.md">简体中文</a> | | ||
<a href="CONTRIBUTING.de-DE.md">Deutsch</a> | | ||
<span>Français</span> | | ||
<a href="CONTRIBUTING.es-ES.md">Español</a> | ||
</p> | ||
|
||
## Processus | ||
|
||
1. Soumettez un problème décrivant les modifications que vous souhaitez apporter. S'il s'agit uniquement de modifications mineures/corrections de bogues, vous pouvez passer directement à l'étape 3. | ||
2. Après avoir discuté de la portée dans le problème, assignez-le vous-même. Il devrait apparaître dans la colonne "À faire" du projet OpenBot. | ||
3. Forkez le projet et clonez-le localement : | ||
|
||
`git clone https://github.com/<user_id>/OpenBot.git` | ||
|
||
4. Créez une branche : | ||
|
||
`git checkout -b <nom-de-branche>` | ||
|
||
où `<nom-de-branche>` décrit de manière concise la portée du travail. | ||
|
||
5. Faites le travail, écrivez de bons messages de commit, poussez votre branche vers le dépôt forké : | ||
|
||
```bash | ||
git add <fichier modifié> | ||
git commit -m <description significative> | ||
git push --set-upstream origin <nom-de-branche> | ||
``` | ||
|
||
6. Créez une [pull request](https://github.com/intel-isl/OpenBot/pulls) sur GitHub et liez-y le problème. Il devrait apparaître dans la colonne "En cours" du projet OpenBot. | ||
7. Travaillez sur les retours de révision de code que vous pourriez recevoir et poussez-les vers votre fork. La pull request se met à jour automatiquement. | ||
8. Prenez une boisson fraîche de votre choix pour vous récompenser d'avoir rendu le monde meilleur. | ||
|
||
## Directives | ||
|
||
- Utilisez le même style et formatage que le reste du code. | ||
- Pour le code Java (Android) et Python, voir [ci-dessous](#Formatage). | ||
- Pour tout autre code, essayez simplement de vous fondre dans le style existant. | ||
- Mettez à jour la documentation associée aux modifications de code que vous avez apportées. | ||
- Si vous souhaitez inclure des dépendances tierces, veuillez en discuter d'abord dans le problème. | ||
- Les pull requests doivent implémenter des fonctionnalités uniques avec le moins de modifications possible. | ||
- Assurez-vous de ne pas inclure de fichiers temporaires ou binaires (les gitignores devraient s'en charger pour la plupart). | ||
- Rebasez/fusionnez master dans votre branche avant de soumettre la pull request. | ||
- Si possible, testez votre code sur Windows, Linux et OSX. | ||
|
||
## Formatage | ||
|
||
### Java | ||
|
||
Nous utilisons un script gradle pour formater le code java. Assurez-vous d'être dans le répertoire `android`. | ||
|
||
Vous pouvez vérifier votre code avec : | ||
|
||
```bash | ||
./gradlew checkStyle | ||
``` | ||
|
||
Vous pouvez appliquer le style à tous les fichiers en exécutant : | ||
|
||
```bash | ||
./gradlew applyStyle | ||
``` | ||
|
||
### Python | ||
|
||
Nous utilisons [black](https://pypi.org/project/black/) pour formater le code python. | ||
|
||
Vous pouvez vérifier votre code dans le répertoire actuel avec : | ||
|
||
```bash | ||
black --check . | ||
``` | ||
|
||
Vous pouvez appliquer le style à tous les fichiers dans le répertoire actuel en exécutant : | ||
|
||
```bash | ||
black . | ||
``` | ||
|
||
## Ressources supplémentaires | ||
|
||
Si vous cherchez plus d'informations sur la contribution aux projets open-source, voici deux bonnes références : | ||
|
||
- [Comment contribuer à l'open source](http://opensource.guide/how-to-contribute/) | ||
- [Le guide du débutant pour contribuer à un projet GitHub](https://akrabat.com/the-beginners-guide-to-contributing-to-a-github-project/) | ||
|
||
Merci beaucoup ! |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.