Skip to content

Commit 3c15fbf

Browse files
committed
feat: update README.md
1 parent bfddce6 commit 3c15fbf

File tree

1 file changed

+87
-1
lines changed

1 file changed

+87
-1
lines changed

README.md

Lines changed: 87 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,87 @@
1-
# algorithmic-programming-challenges
1+
# algorithmic-programming-challenges
2+
3+
## Contribution Guidelines
4+
5+
We welcome contributions from developers! You can fork this repository and submit pull requests to:
6+
7+
- Add your own solution proposals to existing challenges.
8+
- Add new challenges to the collection.
9+
- Add support for new programming languages.
10+
11+
### Important Notes for Adding New Languages
12+
13+
- When adding a new programming language, please create a separate branch named after the language (e.g., `python`, `java`, `cpp`) instead of committing directly to the `main` branch.
14+
- This helps keep the main branch clean and organized.
15+
16+
## Recommended Folder Structure
17+
18+
To maintain an organized and scalable project, we suggest the following folder structure:
19+
20+
```
21+
/<difficulty-level>/
22+
/<programming-language>/
23+
/<challenge-name>/
24+
/proposed-solution/
25+
main.<ext>
26+
other source files...
27+
/@your-github-username/
28+
your solution files...
29+
article.md
30+
```
31+
32+
- `<difficulty-level>`: e.g., `1-EASY`, `2-NORMAL`, `3-HARD`
33+
- `<programming-language>`: e.g., `Python`, `Java`, `C++`
34+
- `<challenge-name>`: descriptive folder name for each challenge
35+
- `proposed-solution`: contains the solution source code files by the owner @IbatoLionDev
36+
- `@your-github-username`: folders for contributors to add their own solutions at the same level as `proposed-solution`
37+
- `article.md`: contains the bilingual documentation for the challenge
38+
39+
### Note on Solution Folders
40+
41+
The `proposed-solution` folder is exclusive for the solution by the owner @IbatoLionDev. To add your own solutions, please create a folder with your GitHub handle (e.g., `@YourUsername`) at the same level as the `proposed-solution` folder, not inside it. Place your code inside your folder.
42+
43+
If you, as an independent user, feel the need to explain your solution, please prepare an `article.md` file inside your folder.
44+
45+
---
46+
47+
## Guía de Contribución
48+
49+
Damos la bienvenida a contribuciones de desarrolladores. Puedes hacer un fork de este repositorio y enviar pull requests para:
50+
51+
- Añadir tus propias propuestas de solución a retos existentes.
52+
- Añadir nuevos retos a la colección.
53+
- Añadir soporte para nuevos lenguajes de programación.
54+
55+
### Notas Importantes para Añadir Nuevos Lenguajes
56+
57+
- Cuando añadas un nuevo lenguaje de programación, por favor crea una rama separada con el nombre del lenguaje (por ejemplo, `python`, `java`, `cpp`) en lugar de hacer commits directamente en la rama `main`.
58+
- Esto ayuda a mantener la rama principal limpia y organizada.
59+
60+
## Estructura Recomendada de Carpetas
61+
62+
Para mantener un proyecto organizado y escalable, sugerimos la siguiente estructura de carpetas:
63+
64+
```
65+
/<nivel-de-dificultad>/
66+
/<lenguaje-de-programacion>/
67+
/<nombre-del-reto>/
68+
/propuesta-solucion/
69+
main.<ext>
70+
otros archivos fuente...
71+
/@tu-nombre-de-usuario-github/
72+
tus archivos de solución...
73+
articulo.md
74+
```
75+
76+
- `<nivel-de-dificultad>`: por ejemplo, `1-EASY`, `2-NORMAL`, `3-HARD`
77+
- `<lenguaje-de-programacion>`: por ejemplo, `Python`, `Java`, `C++`
78+
- `<nombre-del-reto>`: nombre descriptivo para cada reto
79+
- `propuesta-solucion`: contiene los archivos fuente de la solución del propietario @IbatoLionDev
80+
- `@tu-nombre-de-usuario-github`: carpetas para que los colaboradores añadan sus propias soluciones al mismo nivel que `propuesta-solucion`
81+
- `articulo.md`: contiene la documentación bilingüe para el reto
82+
83+
### Nota sobre las carpetas de solución
84+
85+
La carpeta `propuesta-solucion` es exclusiva para la solución del propietario @IbatoLionDev. Para añadir tus propias soluciones, crea una carpeta con tu usuario de GitHub (por ejemplo, `@TuUsuario`) al mismo nivel que la carpeta `propuesta-solucion`, no dentro de ella. Coloca tu código dentro de tu carpeta.
86+
87+
Si tú, como usuario independiente, consideras necesario explicar tu solución, por favor prepara un archivo `articulo.md` dentro de tu carpeta.

0 commit comments

Comments
 (0)