Download contributing - Download de código fonte contributing

contributing

Outro código-fonte

1.0.0

Baixar

Contribuindo para o ideoxan

Introdução

Primeiro de tudo, a equipe de desenvolvedores da Ideoxan gostaria de agradecer pessoalmente por reservar um tempo para contribuir com nosso projeto e a comunidade!

Este documento contém todas as informações necessárias para contribuir para o projeto ideoxan. Se você tiver alguma dúvida, entre em contato conosco em [email protected].

Código de Conduta e Licenciamento

Este projeto é mantido e governado de acordo com o código de conduta oficial do projeto. O acordo com seus termos e condições, juntamente com os Termos de Serviço Oficial da Ideoxan, a Política de Privacidade da Ideoxan e a licença incluída (MIT) é obrigada a contribuir para o projeto desta organização.

Índice

Contribuindo para o ideoxan
- Introdução
  - Código de Conduta e Licenciamento
  - Índice
- Configuração para contribuir
  - Pré-requisitos
    - Node.js
    - Git
    - ES6 Apoio ao navegador
    - MongoDB
  - Instalação
    - Variáveis de ambiente
      - URI MONGODB
      - Segredo de sessão expressa
      - Hash de senha
    - Uma pequena nota no currículo
    - Outra pequena nota, mas desta vez em ramificações git
  - Correndo
    - Modo de desenvolvedor
    - SSU normal
    - Implantação do servidor
- Contribuindo para o projeto
  - Relatar problemas de segurança
  - Relatando bugs ou problemas
    - Lista de verificação de bug
      - Este problema pertence a este projeto?
      - Eu causei o problema?
      - Estou usando a versão certa do software necessário?
      - Esta questão já foi relatada?
      - O problema é relacionado à segurança?
    - Arquivamento e emissão
  - Contribuindo para a base de código
  - Sugerindo e aprimoramento ou recurso
  - Atualizando documentação
  - Outro
- Padrões e guias de estilo
  - Padrões
    - Documentação
    - Rótulos de edição/PR
      - Bugs
      - Relacionado à questão
      - Especificação
      - Misc
- Contate-nos

Configuração para contribuir

Pré-requisitos

Node.js

O tempo de execução do Node.js é necessário para executar o servidor de back -end (que é o que serve ao site). Versões acima 10.x são suportadas. Sugere -se usar o nó 13.x O NPM também é necessário, mas normalmente vem instalado com o Node.JS. Você pode verificar a versão Node.js fazendo

node -v

Git

A CLI Git é necessária para baixar o código do repositório.

ES6 Apoio ao navegador

Um navegador moderno que suporta as especificações do ES6 para JS é obrigado a visualizar o site Chrome/Chromium, Firefox e Safari.

MongoDB

Embora o MongoDB não seja 100% necessário para executar o site, sugerimos que você o instale de qualquer maneira, para que os logins e a verificação do usuário possam ser usados. Para instalar o MongoDB, consulte seu guia de documentação. Verifique se o servidor está em execução no localhost ou outro local especificado na lista local ou de sistema de variáveis de ambiente

Instalação

Use o seguinte para baixar o repositório e instalar os pacotes necessários:

git clone https://github.com/ideoxan/ideoxan.git
cd ideoxan
npm install

Variáveis de ambiente

O servidor suporta o uso de variáveis ambientais em todo o sistema e o ambiente. Se você não conseguir definir uma variável de ambiente em todo o sistema, crie um arquivo .env no diretório principal do ideoxan. Verifique se o ambiente do seu nó não está definido para production caso contrário, as variáveis de ambiente não serão usadas localmente. A seguir, é apresentada uma lista de variáveis de ambiente usadas. Se algum deles estiver conflitante, informe -nos.

MONGO_URI
EXPRESS_SESSION_SECRET
PWD_HASH

URI MONGODB

A variável de ambiente MONGO_URI é usada para definir o URI do banco de dados MongoDB. Este URI deve ser uma string monongouri válida. O padrão é mongodb://localhost:27017/ix

Segredo de sessão expressa

A variável EXPRESS_SESSION_SECRET Environment é o segredo de que todas as sessões autenticadas com esse servidor usarão. É melhor manter isso seguro e seguro, pois isso pode ser usado para invalidar, modificar e paródia sessões (o que não é bom). Mantenha isso o mais longo e complexo possível. Não há inadimplência devido a razões de segurança.

Hash de senha

A variável de ambiente PWD_HASH é um valor inteiro usado para hash senhas no módulo BCRYPTJS. Mantenha o número alto o suficiente, onde as senhas são seguras, mas baixas o suficiente para que o servidor diminua a velocidade. Novamente, por razões de segurança, não há valor padrão.

Uma pequena nota no currículo

Se você deseja contribuir para um curso ou aula, consulte nossos outros repositórios do GitHub com o prefixo do curriculum- . Todos os nossos guias de currículo são mantidos no GitHub (nem todos estão disponíveis ao público) e são armazenados a lado /static/curriculum e são solicitados pelo lado do cliente no diretório estático expresso ( /static ). O currículo não está incluído no editor, site ou qualquer um de seus conteúdos. No Git, esses cursos são incluídos como submódulos e podem ser instalados no diretório curricular usando o seguinte:

git submodule init
git submodule update --recursive

Isso clonará, buscará e puxará todos os cursos publicamente disponíveis. Se você deseja saber mais sobre os submódulos Git e como eles funcionam, clique aqui.

Outra pequena nota, mas desta vez em ramificações git

Existem dois ramos principais que são usados: master e prod . A filial prod é o que é enviado para produção e implantação. Tentamos atualizar apenas essa ramificação de vez em quando quando necessário (os hotfixes são mais lentos para serem mesclados). O ramo master é para onde a maioria de nossos novos começos vai. Pense nisso como um sistema de construção noturno fresco. Embora essa filial tenha o código mais recente, isso não significa que é o mais estável. Se você planeja usá -lo a longo prazo e não tiver vontade de atualizar a cada 20 minutos, sugerimos que você use a filial prod .

Correndo

Existem três opções para executar o servidor.

Modo de desenvolvedor

Modo de desenvolvedor é o comando para executar o servidor em uma máquina de desenvolvimento. Isso permite fácil edição e inicialização rápida do servidor. Ele depende do pacote Nodemon, portanto, verifique se as dependências do desenvolvedor descritas no arquivo package.json estão instaladas via NPM.

Para executar o servidor, use localmente:

npm run dev

SSU normal

Para iniciar o servidor sem recursos adicionais, execute:

npm run start

Isso atualiza automaticamente os submódulos incluídos e inicia o servidor. Como alternativa, o servidor pode ser iniciado como qualquer projeto normal Node.js:

node server.js

Implantação do servidor

Este método não é sugerido para ser usado, pois esta opção é personalizada para servidores específicos usados pelo ideoxan.

Isso exige que o PM2 seja instalado globalmente .

npm run server

Se isso não funcionar, use:

pm2 start server.js --name ideoxan --max-memory-restart 500M --watch --cron " 0 2 * * * "

Contribuindo para o projeto

Relatar problemas de segurança

Em primeiro lugar, se você acredita que o problema é um referente à segurança, não abra um problema. Relate o bug diretamente para nós por e -mail

O problema que você está relatando é normalmente um problema de segurança quando ...

Você pode acessar, visualizar, editar, ou de qualquer maneira alterar algo que não é seu
Você descobriu algo que provavelmente não é o trabalho de ideoxan, seus parceiros, pacotes, colaboradores, anunciantes verificados ou mantenedores no site, no repositório de código ou em qualquer outro lugar
Você descobriu uma possível maneira de abusar da API, site ou servidor
Seu sistema foi comprometido devido ao uso do ideoxan e de seus produtos

Se você experimentou alguma das opções acima, é provavelmente o resultado de um possível risco de segurança e deve ser relatado. O não relato pode resultar em uma possível ação legal em nosso nome.

Mesmo que seu problema não atenda ao acima e ainda acredite que é um problema relacionado à segurança, não hesite em nos enviar um e -mail. É melhor estar seguro do que se arrepender.

Relatando bugs ou problemas

Lista de verificação de bug

Verifique o seguinte para garantir que você esteja liberado para abrir um problema.

Este problema pertence a este projeto?

Se o seu problema tiver a ver com o tempo de execução do Node.js, qualquer um dos pacotes/software que não é coberto/mantido pelo Ideoxan, ou qualquer outra coisa, este não é o local adequado para apresentar seu problema. Se você precisar de ajuda para ser direcionado para o rastreador de bugs adequado ou o guia de solução de problemas, sinta -se à vontade para entrar em contato conosco. (Veja entre em contato conosco)

Eu causei o problema?

Se você modificou alguma fonte, há uma alta probabilidade de que o problema tenha sido causado por adulteração. Se o problema ainda persistir depois de reverter seu código, abra um problema.

Estou usando a versão certa do software necessário?

Não suportamos software antigo. Verifique suas versões em relação às especificadas na master Branch package.json / package-lock.json e na seção Pré-requisitos em nosso guia contribuinte.

Esta questão já foi relatada?

Se o problema já foi relatado e ainda está aberto em nosso github, comente seu problema em vez de abrir um novo problema. Se ainda não estiver aberto, verifique o status dele. Se tiver a tag wont-fix anexada ao problema, não a traga novamente, a menos que você a veja como um problema de destaque e uma quantidade significativa de tempo passou. Verifique também para ver se existe uma solução. Às vezes, os problemas serão fechados não porque foram marcados como inválidos ou uma solução foi alcançada, mas por falta de atividade. Se você achar que esse é o caso, sinta-se à vontade para solicitar que o problema seja reaberto.

O problema é relacionado à segurança?

Se você emitir relacionar -se à segurança, consulte Relatando problemas de segurança.

Arquivamento e emissão

Se você seguiu o acima e atendeu aos requisitos, agora poderá abrir um problema. Certifique -se de usar um título descritivo e descreva claramente seu problema. Certifique -se de seguir o modelo de relatório de bugs (sugerido fortemente). Se você não descrever seu problema corretamente, seu problema será fechado sem explicação.

Contribuindo para a base de código

Se você estiver contribuindo para a base de código (não incluir documentação), siga nossos padrões.

Verifique se já existem problemas abertos que podem ser resolvidos. Caso contrário, verifique se uma solicitação de tração ainda não cobre o que você está tentando mesclar.

Se você tem certeza do exposto acima, abra uma solicitação de tração usando nosso modelo de relações públicas

Sugerindo e aprimoramento ou recurso

Se você está sugerindo que o ideoxan adiciona um novo recurso ou se expanda a um existente, abra um problema usando o modelo de solicitação de recurso

Atualizando documentação

Em breve

Outro

Se você tiver uma pergunta ou preocupação que não atenda ao acima, sinta -se à vontade para nos alcançar (veja entre em contato conosco)

Padrões e guias de estilo

Esse repositório se esforça para permitir compatibilidade, uniformidade e legibilidade geral. Sugerimos que, se você estiver tentando contribuir com a fonte deste projeto, que leia o seguinte.

Padrões

Documentação