Skip to content

#7 Adding PT-BR docs and docs folder #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 9 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
76 changes: 76 additions & 0 deletions 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]](mailto:[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
53 changes: 53 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Contributing

This project is released under the MPL 2.0 license.
Before implementing new features and changes, feel free to [submit an issue](https://github.com/CollabCodeTech/collabcodetraining-frontend/issues/new). We're going to talk here :stuck_out_tongue_winking_eye:.

### Code of Conduct

This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).

### Issues and Questions

We have an official [Discord](https://discord.gg/YeeEAYj) server where we can give helpful advices if you have questions.

## How to submit a pull request?

1. Fork [this repository](https://github.com/CollabCodeTech/collabcodetraining-frontend/fork).
2. Create a new branch with the feature name. (Eg: feature/chat-support, hotfix/website-header)
3. Make your changes.
4. Commit your changes. Please follow the [styleguides](#styleguides)
5. Push your changes.
6. Submit your pull request.

We use [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) so unless your PR is a `hotfix`, your feature branch must be created from the `develop` branch.

**TIP:** This [Git extension](https://github.com/nvie/gitflow) makes Git Flow a piece of cake. GitKraken also has [built-in support](https://support.gitkraken.com/git-workflows-and-extensions/git-flow/) for GitFlow

## Styleguides
### Git Commit Styleguide

* Use the present tense ("Add feature" not "Added feature")
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
* Limit the first line to 72 characters or less
* Reference issues and pull requests liberally after the first line
* Consider starting the commit message with an applicable emoji:
* :art: `:art:` when improving the format/structure of the code
* :zap: `:zap:` when improving performance
* :pencil: `:pencil:` when writing docs
* :penguin: `:penguin:` when fixing something on Linux
* :apple: `:apple:` when fixing something on macOS
* :checkered_flag: `:checkered_flag:` when fixing something on Windows
* :bug: `:bug:` when fixing a bug
* :fire: `:fire:` when removing code or files
* :green_heart: `:green_heart:` when fixing the CI build
* :white_check_mark: `:white_check_mark:` when adding or updating tests
* :lock: `:lock:` when dealing with security
* :arrow_up: `:arrow_up:` when upgrading dependencies
* :arrow_down: `:arrow_down:` when downgrading dependencies
* :rotating_light: `:rotating_light:` when removing linter warnings
* Full emoji reference in [gitmoji](https://gitmoji.carloscuesta.me/)

### FrontEnd Styleguide & Layout

Please check the layout on [Figma](https://www.figma.com/file/gL5DC1W2R9zhfCRRXAjJGn/CollabWorld.training?node-id=1%3A384). You must sign in to Figma to view the layout properties.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ See also the list of [contributors](https://github.com/CollabCodeTech/collabcode

## License

This project is licensed under the MPL 2.0 License - see the [LICENSE](LICENSE.md) file for details
This project is licensed under the MPL 2.0 License - see the [LICENSE](LICENSE) file for details

## Acknowledgments

Thanks to all members of CollabCode's community for the support! We love you!
Thanks to all members of CollabCode's community for the support! We love you!
74 changes: 74 additions & 0 deletions docs/CODE_OF_CONDUCT-PT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Código de Conduta do Contribuidor

## Nosso Juramento

No interesse de promover um ambiente aberto e acolhedor, nós, como
colaboradores e mantenedores comprometemos a participar do nosso projeto e
de nossa comunidade, nutrindo uma experiência livre de assédio para todos,
independentemente da idade, do tamanho do corpo, deficiência, etnia,
características sexuais, identidade e expressão de gênero,
nível de experiência, educação, status socioeconômico, nacionalidade,
aparência pessoal, raça, religião ou identidade e orientação sexual.

## Nossos princípios

Exemplo de comportamento que contribui para criar um ambiente positivo
Incluem:

* Usando linguagem acolhedora e inclusiva
* Sendo respeitoso(a) para com as diferentes perspectivas e experiências
* Aceitando respeitosamente críticas construtivas
* Focando no que é melhor para a comunidade
* Mostrando empatia com outros membros da comunidade

Exemplos de comportamente inaceitável incluem:

* O uso de linguagem sexual ou avanços sexuais não bem-vindos
* Trollando, insultando e ataques pessoais ou políticos
* Abuso público ou privado
* Publicar informação pessoal de outros, como endereços tanto eletrônicos quanto físico, sem permissão
* Outras condutas que poderiam ser consideradas inapropriadas no ambiente de trabalho

## Nossa Responsabilidade

Os mantenedores do projeto são responsáveis ​​por esclarecer os padrões de comportamento
aceitável e espera-se que adotem ações corretivas apropriadas e justas
em resposta a quaisquer instâncias de comportamento inaceitável.

Os mantenedores do projeto têm o direito e a responsabilidade de remover, editar ou
rejeitar comentários, confirmações, códigos, edições na wiki, problemas e outras contribuições
que não estejam alinhados com este Código de Conduta ou que proíbam temporariamente ou
banir permanentemente qualquer colaborador por outros comportamentos
que considerem inapropriado, ameaçador, ofensivo ou prejudicial.

## Alcance

Este Código de Conduta se aplica a todos os espaços do projeto e também quando
um indivíduo está representando o projeto ou sua comunidade em espaços públicos.
Exemplos de representação de um projeto ou comunidade incluem o uso de um endereço de
e-mail oficial do projeto, publicando em uma conta oficial de mídia social ou agindo
como representante designado em um evento online ou offline. Representação de
um projeto pode ser ainda definido e esclarecido pelos mantenedores do projeto.

## Execução

Instâncias de comportamento abusivo, assediador ou inaceitável podem ser
relatados entrando em contato com a equipe do projeto em [[email protected]] (mailto: [email protected]). Todas
reclamações serão analisadas e investigadas e resultarão em uma resposta que
é considerado necessário e adequado às circunstâncias. A equipe do projeto é
obrigada a manter a confidencialidade em relação ao relator de um incidente.
Detalhes adicionais de políticas específicas de imposição podem ser publicados separadamente.

Os mantenedores do projeto que não seguem ou aplicam o Código de Conduta em boa
fé podem enfrentar repercussões temporárias ou permanentes, conforme determinado por outros
membros da liderança do projeto.

## Atribuição

Esse código de conduta é adaptado do [Contributor Covenant][homepage], versão 1.4,
acessível em https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[Página Home]: https://www.contributor-covenant.org

Para respostas de perguntas frequentes sobre esse código de conduta, veja
https://www.contributor-covenant.org/faq
53 changes: 53 additions & 0 deletions docs/CONTRIBUTING-PT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Contribuindo

Esse projeto é feito sob a MPL 2.0 license.
Antes de implementar novas mudanças, [envie uma issue](https://github.com/CollabCodeTech/collabcodetraining-frontend/issues/new). Nós iremos conversar aqui :stuck_out_tongue_winking_eye:.

### Código de Conduta

Esse projeto adere ao código do contribuidor [código do contribuidor](CODE_OF_CONDUCT_PT.md). Por participar, é esperado que você mantenha esse código. Porfavor, reporte conportamentos inaceitáveis para [[email protected]](mailto:[email protected]).

### Problemas e Questões

Nós temos um server no [Discord](https://discord.gg/YeeEAYj) aonde nós podemos lhe dar conselhos úteis, caso você tenha alguma questão.

## Como eu submeto uma pull request?

1. Faça um fork [desse repositório](https://github.com/CollabCodeTech/collabcodetraining-frontend/fork).
2. Crie uma nova branch com o nome da sua mudança. (Ex: feature/chat-support, hotfix/website-header)
3. Faça sua mudança.
4. Faça o commit de suas mudanças. Porfavor siga o [guia de estilo](#styleguides)
5. Faça o push de suas mudanças.
6. Submeta seu pull request.

Nós usamos [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) então, a não ser que sua PR seja um `hotfix`, seu novo branch precisa ser criado do branch `develop`.

**Dica:** Essa [extansão do Git](https://github.com/nvie/gitflow) facilita o uso do Git Flow. GitKraken também possui [suporte](https://support.gitkraken.com/git-workflows-and-extensions/git-flow/) para o GitFlow

## Guia de estilo
### Guia de estilo para Git Commit

* Use os verbos no presente ("Adicione uma mudança" não "Adicionei uma mudança")
* Use o modo imperativo ("Mova o cursor para..." não "Move-se o cursor para...")
* Limite a primeira linha para 72 caracteres ou menos
* Referencie seus issues e pull requests depois da primeira linha
* Considere começar a mensagem de commit com o respectivo emoji:
* :art: `:art:` quando melhorando o formato ou a estrutura do código
* :zap: `:zap:` quando melhorando a performance
* :pencil: `:pencil:` quando documentando
* :penguin: `:penguin:` quando arrumando algo no Linux
* :apple: `:apple:` quando arrumando algo no macOS
* :checkered_flag: `:checkered_flag:` quando arrumando algo no Windows
* :bug: `:bug:` quando arrumando um bug
* :fire: `:fire:` quando removendo arquivos ou código
* :green_heart: `:green_heart:` quando arrumando a build do CI
* :white_check_mark: `:white_check_mark:` quando adicionando ou renovando testes
* :lock: `:lock:` quando lidando com segurança
* :arrow_up: `:arrow_up:` quando melhorando as dependencias
* :arrow_down: `:arrow_down:` quando usando versões mais antigas das dependencias
* :rotating_light: `:rotating_light:` quando removendo avisos de sintaxe
* Referência completa dos emojis [gitmoji](https://gitmoji.carloscuesta.me/)

### Guia de estilo para o FrontEnd

Porfavor cheque o layout no [Figma](https://www.figma.com/file/gL5DC1W2R9zhfCRRXAjJGn/CollabWorld.training?node-id=1%3A384). Você precisa estar logado no Figma para ver as propriedades do layout.
54 changes: 54 additions & 0 deletions docs/README-PT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
![CollabCode](collabcode.png "Logo da CollabCode")

# CollabCode Training

Uma plataforma 'open source' de cursos online.

## Começando

1. Faça o fork desse repositório e clone ele em sua máquina;

2. Mude o diretório para `collabcodetraining-frontend` aonde você tiver clonado;

3. No terminal, rode:

```bash
npm install
npm run dev
```

4. Abra [localhost:3000](http://localhost:3000) e comece a usar

Esse projeto usa Sapper para SvelteJS, se você tiver alguma dúvida sobre como Sapper ou SvelteJS funciona, porfavor consulte [sapper.svelte.dev](https://sapper.svelte.dev) e [svelte.dev](https://svelte.dev) para ajuda de como começar.

### Pré-requisitos

* Npm
* Node (>=10.16.3)

## Rodando testes

TBC

## Build com

* [Sapper](https://sapper.svelte.dev)

## Contribuindo

Porfavor leia [CONTRIBUTING_PT.md](CONTRIBUTING_PT.md) para detalher de nosso código de conduta, e o processo para submeter sua pull request.

## Autores

* **Joviane Jardim** - [@joviane](https://twitter.com/jovianejardim)
* **Marco Bruno** - [@marcobrunobr](https://twitter.com/marcobrunobr)

Veja também a lista de [contribuidores](https://github.com/CollabCodeTech/collabcodetraining-frontend/contributors) que participaram deste projeto.

## Licença

Esse projeto é licenciado pela MPL 2.0 License - veja o arquivo [LICENÇA](LICENSE) para mais detalhes.

## Reconhecimentos

Obrigado para todos os membros da comunidade do CollabCode pelo suporte! Nós amamos vocês!