Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/codewarriorsdevs/estecon

"Estecon" É um projeto de portifolio profissional voltado a uma empresa de contabilidade da cidade de Pedro II - PI
https://github.com/codewarriorsdevs/estecon

framer-motion javascript material-ui projeto-ativo react

Last synced: 17 days ago
JSON representation

"Estecon" É um projeto de portifolio profissional voltado a uma empresa de contabilidade da cidade de Pedro II - PI

Awesome Lists containing this project

README 

        
# Estecon



Welcome to the Estecon project! Estecon is a professional portfolio project focused on showcasing the services of an accounting firm based in Pedro II - PI. Below, you'll find the guidelines and standards that we follow during the development process.



## Standards and Best Practices



To maintain consistency and ensure the quality of our codebase, we follow the guidelines listed below:



### 1. Semantic Commits



We use semantic commits to provide meaningful information about the changes made in the codebase. Below are the common commit types:



- `feat:` for new features

- `fix:` for bug fixes

- `docs:` for documentation updates

- `style:` for formatting changes (no code changes)

- `refactor:` for code refactoring (neither fixes nor features)

- `perf:` for performance improvements

- `test:` for adding or updating tests

- `chore:` for maintenance and other tasks that don't affect the source code (e.g., updating build tasks, package manager configurations)

- `ci:` for CI/CD pipeline changes



Example commit message:



`git commit -a -m "feat: login form validation implemented."`



### 2. Use English for Documentation, Issues and PRs



English is the standard language for all documentation, issues and PRs in Estecon. This includes:



- Code comments

- Readme files

- Inline documentation

- Variable and function names (where applicable)



Using English helps us reach a broader audience and makes it easier for contributors from around the world to participate.



### 3. Use camelCase for Naming Conventions



In Estecon, we use camelCase for naming variables, functions, and objects in JavaScript and other applicable languages. This standard helps improve readability and maintainability.



- Use `camelCase` for variables and function names, e.g., `getUserData`.

- Use `PascalCase` for class and component names, e.g., `UserProfile`.

- Avoid using underscores (`_`) in names unless necessary for specific conventions or external APIs.



### 4. Use Semantic Tags



Semantic HTML tags enhance the accessibility, SEO, and readability of the application. Make sure to use tags that describe the content accurately:



- Use ``, ``, ``, ``, ``, and other semantic tags instead of generic `
` and `` where applicable.

- Proper use of `` to denote the main content of the document.

- `` for complementary content, such as sidebars.



This practice improves the structure and usability of the application and makes the code more readable for other developers.



## Contributing



We welcome contributions to Estecon! Please ensure that any changes adhere to the standards outlined above. Feel free to open a pull request or an issue if you have any suggestions or need further clarifications.



## License



Estecon is open-source and available under the [MIT License](LICENSE).



## Contact



For any questions, please reach out to our team or open an issue in the repository.



---



Thank you for contributing to Estecon!