Skip to content

Latest commit

聽

History

History
212 lines (165 loc) 路 9.44 KB

CONTRIBUTING.md

File metadata and controls

212 lines (165 loc) 路 9.44 KB
Raw

Contributing to DogeHouse

Please read the PRIORITY LIST before contributing.

We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:

  • Reporting an issue
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features
  • Becoming a maintainer

Code of Conduct

The code of conduct is described in CODE_OF_CONDUCT.md.

Our Development Process

All changes happen through pull requests. Pull requests are the best way to propose changes. We actively welcome your pull requests and invite you to submit pull requests directly here, and after review, these can be merged into the project.

Using the Project's Standard Commit Messages

This project is using the conventional commits standard. Please follow these steps to ensure your commit messages are standardized:

  1. Make sure your shell path is in the root of the project (not inside any of the packages).
  2. Run yarn.
  3. Stage the files you are committing with git add [files].
  4. Run yarn commit. This will start an interactive prompt that generates your commit message:
    1. Select the type of change.
    2. Type the scope. This is either global for project-wide changes or one of the packages (kibbeh, shawarma etc.).
    3. Write a short, imperative tense description of the change.
    4. If the above was not sufficient, you may now write a longer description of your change (otherwise press enter to leave blank).
    5. y or n for whether there are any breaking changes (e.g. changing the props of a component, changing the JSON structure of an API response).
    6. y or n for whether this change affects an open issue, if positive you will be prompted to enter the issue number.
  5. Your commit message has now been created, you may push to your fork and open a pull request (read below for further instructions).

Pull Requests

  1. Fork the repo and create your branch (usually named patch-%the number of PRs you've already made%) from staging.
  2. If you've added code that should be tested, add some test examples.
  3. Ensure to describe your pull request.

Adding Emojis

Emojis need to be 28x28px. To add an emoji, add the png/gif image to public/emojis and add the emoji to the kofta/src/app/modules/room-chat/EmoteData.ts.

To avoid conflicts please add the emojis to the top of the file.

NOTE: We are not accepting new emojis atm

Quickstart Local Frontend Development

Do this if you only want to do React stuff and don't want to touch Elixir:

UI (react + next.js):

Navigate to /kibbeh

  • Run yarn
  • Run yarn staging (this tells React to connect to a hosted version of the backend for development purposes).
  • Read kibbeh/README.md for more information and fixes for known development issues.

NOTE: Please follow the design guidelines and figma mockups and if what you're trying to do isn't in there, consult @ajmnz/@benawad beforehand.

Translating

  1. Fork the repository (click on fork in the top right corner of the screen) image

  2. In the forked repository, navigate to kibbeh/public/locales and then choose your language and open the translation.json file

  3. Click on edit in the top right corner of the window

image

  1. Make the changes in the translation(make sure you are using the correct json syntax)
  2. click commit changes in the bottom of the page and add fix(kibbeh): update {my language} Translation as the commit message(fix if you are fixing tranlsations and feat if you are adding a language)(leave the description empty!) image
  3. Go to the main page of the repository and under Contribute, click on Open Pull Request

Supporting translation in new components

  1. Add your translation key into the English translation.json located in kibbeh/public/locales/en/translation.json. Make sure it is put in an appropriate section that makes sense.
  2. Run yarn i18. This will sync all fields in all languages, if field doesn't exist it will copy it over from en.
  3. Use your translation key in your code. This is done by using useTypeSafeTranslation like this: const { t } = useTypeSafeTranslation();. You can now call t and get your desired translation key.

Devcontainer Full Local Development

For VSCode users, we're able to use devcontainers which allows you to create development environments that already have all the tools and services configured and ready to go.

Usage

Prerequisite: Install Docker on your local environment.

To get started, read and follow the instructions in Developing inside a Container. The .devcontainer/ directory contains pre-configured devcontainer.json, docker-compose.yml and Dockerfile files, which you can use to set up remote development within a docker container.

  • Install the Remote - Containers extension.
  • Open VSCode and bring up the Command Palette.
  • Type Remote-Containers: Open Folder in Container, this will build the container with Elixir and Node installed, this will also start Postgres and RabbitMQ instances.

If you need to modify environment variables for kousa, you need to modify them inside /home/doge/.bashrc and restart your terminal.

Run

kousa

$ mix deps.get
$ mix ecto.migrate
$ iex -S mix

shawarma

$ yarn
$ yarn build
$ yarn start

kibbeh

$ yarn
$ yarn dev

Manual Full Local Development

How to run locally:

Backend

RabbitMQ

Install RabbitMQ:

  • macOS: Run brew install rabbitmq.
  • Windows: Run choco install rabbitmq.
  • Linux: Follow their installation guide here.

Start RabbitMQ

  • macOS: Run brew services start rabbitmq.
  • Windows: Setup guide here.
  • Linux: Setup guide here.

PostgreSQL

Install PostgreSQL:

  • macOS: Run brew install postgresql.
  • Windows: Follow this guide.
  • Linux: Follow this guide.

Start PostgreSQL:

  • macOS: Run brew services start postgresql.
  • Windows: Start PostgreSQL through the control panel or run net start postgresql-{version}.
  • Linux: Run /etc/rc.d/init.d/postgresql start.

Create a DB named kousa_repo2:

$ psql postgres

$ CREATE DATABASE kousa_repo2;

Elixir

Elixir installation guide here.

kousa

Navigate to /kousa and set the following environment variables:

export DATABASE_URL=postgres://user:password@localhost/kousa_repo2
export BEN_GITHUB_ID=7872329
export RABBITMQ_URL=amqp://user:password@yourinternalip:5672
export ACCESS_TOKEN_SECRET=
export REFRESH_TOKEN_SECRET=
export GITHUB_CLIENT_ID=
export TWITTER_API_KEY=
export TWITTER_SECRET_KEY=
export TWITTER_BEARER_TOKEN=
export GITHUB_CLIENT_SECRET=
export SENTRY_DNS=
export API_URL=http://localhost:4001
export WEB_URL=http://localhost:3000
export PORT=4001
export DISCORD_CLIENT_ID=
export DISCORD_CLIENT_SECRET=

You can save these variables in a .txt and run source path/to/file.txt

Run the following commands:

$ mix deps.get
$ mix ecto.migrate

Start the server

$ iex -S mix

shawarma

Navigate to /shawarma and run yarn.

Mediasoup requires node >=0.8 <=14 and has specific requirements on Windows.

Create an .env file and set the following environment variable:

WEBRTC_LISTEN_IP=127.0.0.1

Then run yarn build and yarn start.

Issues

NOTE: If your bug is a security vulnerability, please instead see the security policy

We use GitHub issues to track public bugs. Please ensure your description is clear and has sufficient instructions to be able to reproduce the issue. Report a bug by opening a new issue; it's that easy!

Frequently Asked Questions (FAQs)

- Q: [The Question?]
- A: [The Answer!]

Feature Request

Great Feature Requests tend to have:

  • A quick idea summary.
  • What & why you wanted to add the specific feature.
  • Additional context like images, links to resources to implement the feature etc, etc.

License

By contributing to DogeHouse, you agree that your contributions will be licensed under the LICENSE file.