Skip to content

Commit

Permalink
Docs/use cases (#1)
Browse files Browse the repository at this point in the history
* refactor: rename app.tsx to App.tsx and update main.tsx to use ReactDOM for rendering

* chore: update .gitignore to include .env and add VSCode extensions recommendations

* chore: add .yarnrc.yml and update Vite config to load environment variables

* feat: implement side panel for Google and add sidebar component

* fix: removing alert in production code

* docs: create code-of-conduct file

* docs: create first version of the contributing guidelines

* chore: update Prettier configuration and rename ESLint config file

* docs: add badges and useful links related to the extension purpose

* docs: create .env.example file to show the .env original format

* refactor: update import alias from tsconfig and vite.config

* refactor: ajustar importações e formatação de código em vários arquivos

* Update README.md
  • Loading branch information
bidwolf authored Dec 1, 2024
1 parent 553c1b2 commit b8c0f9d
Show file tree
Hide file tree
Showing 40 changed files with 7,338 additions and 4,512 deletions.
2 changes: 2 additions & 0 deletions .env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
VITE_CHROME_EXTENSION_ID=
VITE_SUMMARIZATION_API_URL=
76 changes: 76 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to make participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies within all project spaces, and it also applies when
an individual is representing the project or its community in public spaces.
Examples of representing a project or community include using an official
project e-mail address, posting via an official social media account, or acting
as an appointed representative at an online or offline event. Representation of
a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
56 changes: 56 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Introduction to Contributing

Contribution is the heart of open-source projects. This project welcomes contributions from everyone. This document will guide you through the process of contributing to this project. To do that, we have some guidelines and a [Code of Conduct](./CODE_OF_CONDUCT.md) that we ask you to follow.

## Recommended Communication Style

1. Always leave screenshots or code snippets to help explain your point.
2. Always leave a detailed description in the pull request. Forget ambiguity.
3. Always review your code before submitting a pull request. Run locally and test it before requesting a review.
4. Always communicate in the GitHub Repository. Whether in the issue or the pull request, keeping the lines of communication open and visible to everyone on the team helps everyone stay on the same page.

## Issues

* If you wish to work on an open issue, please ask for it to be assigned to you.
* If you find a bug, or have a feature request, please open an issue. You can also open a discussion if you have any questions or suggestions.
* If you contribute to the project for the first time, you can search for issues with `good first issue` or `bug` labels in the repository.
>[!NOTE]
> **Please only self-assign a good first issue one time**.
> Maintainers may remove you from the assignees and not accept your pull request if you choose to proceed.
## Commits

* Always use the present tense ("Add feature" not "Added feature", or "Adding feature").
* Always use the imperative mood ("Move cursor to..." not "Moves cursor to...").
* We recommend using the [Conventional Commits][commitsGuidelinesLink] pattern to make it easier to understand the changes made in the project. (e.g. `feat: add new feature`, `fix: correct a bug`, `docs: update README.md`).

>[!NOTE]
> We will add [husky][huskyReference] and [commitlint][commitlintReference] to the project in the future to enforce this pattern.
> We will add a changelog generator in the future.
[commitlintReference]: https://commitlint.js.org/
[huskyReference]: https://typicode.github.io/husky/
[commitsGuidelinesLink]: https://www.conventionalcommits.org/en/v1.0.0/

* Always reference the issue number in the commit message. (e.g. `feat: add new feature #123`). (If there is no issue, create one first).
* Always keep the commits as small as possible. If you have a large commit, try to split it into smaller commits.

## Pull Requests

We actively welcome your pull requests. However, you must ensure that you are assigned to an existing issue before working on changes, and you need to link your work to the issue in your PR form.

---
1. Fork the repository, then clone it to your local machine.
2. Creating a new branch is a must. Before working on your changes, create a new branch from the default branch. Name your branch with something descriptive of your work, i.e., `feat-sidePanel` or `fix/broken-links`.
3. The code must be tested locally before submitting a pull request. If you are adding a new feature, make sure to add tests for it. (We will add a test suite in the future).
4. If you make visual changes, include screenshots or gifs in your pull request.
5. If you improve the existing code, make sure to run the tests and ensure that the code is working as expected and talk about the improvements in the pull request description.
6. We use a **template for the pull request**. Please fill out the template with the necessary information.

## Code Review

The pull request will be reviewed by the maintainers. We will provide feedback on your code and suggest changes if necessary. We may ask you to make changes to your code before merging it. We will also provide feedback on the design, coding style, and testing.

## License

By contributing to the Foca AI project, you agree that your contributions will be licensed under the [MIT License](../LICENSE).
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ yarn-debug.log*
yarn-error.log*
pnpm-debug.log*
lerna-debug.log*
.env

node_modules
dist
Expand Down
8 changes: 8 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"semi": true,
"singleQuote": true,
"tabWidth": 2,
"trailingComma": "es5",
"useTabs": false,
"printWidth": 75
}
8 changes: 0 additions & 8 deletions .prettierrc.js

This file was deleted.

11 changes: 11 additions & 0 deletions .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"recommendations": [
"bradlc.vscode-tailwindcss",
"streetsidesoftware.code-spell-checker",
"hediet.vscode-drawio",
"editorconfig.editorconfig",
"dbaeumer.vscode-eslint",
"dsznajder.es7-react-js-snippets",
"yzhang.markdown-all-in-one"
]
}
Binary file added .yarn/install-state.gz
Binary file not shown.
1 change: 1 addition & 0 deletions .yarnrc.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
nodeLinker: node-modules
Loading

0 comments on commit b8c0f9d

Please sign in to comment.