objectbox / objectbox/objectbox-java
API cleanup
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Java
- Estrellas
- 4.6k
- Forks
- 311
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
Good evening,
I think it would be productive to clean up the API around the library a bit.
There are for example numerous methods/variables that are rather confusing (e.g. box.panicModeRemoveAll() and box.all2), and quite a few calls include "internal" in their names even though they are public. Is there a reason for this?
Its not the end of the world, but I do think it would make a difference - and one of the things I appreciated with Realm earlier on was how everything had its place. You could never see any of its implementation details, and you could fully focus on creating awesome stuff.
Thanks!
Zoltan
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
No se nombran archivos ni pruebas. Empieza por localizar los símbolos de la API pública box.panicModeRemoveAll(), box.all2 y los métodos que contengan internal; después, revisa cómo los expone la biblioteca. Para darlo por terminado, sería necesario acordar el alcance de la limpieza y establecer una nomenclatura pública coherente en toda la API afectada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- api
- Tipo de issue
- Refactorización
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 20/100