Skip to content

Latest commit

 

History

History
130 lines (80 loc) · 4.25 KB

CONTRIBUTING.md

File metadata and controls

130 lines (80 loc) · 4.25 KB
Raw

Contributing to Pongo

We take Pull Requests!

Before you send Pull Request

  1. Contact the contributors via the Discord channel or the Github Issue to make sure that this is issue or bug should be handled with proposed way. Send details of your case and explain the details of the proposed solution.
  2. Once you get approval from one of the maintainers, you can start to work on your code change.
  3. After your changes are ready, make sure that you covered your case with automated tests and verify that you have limited the number of breaking changes to a bare minimum.
  4. We also highly appreciate any relevant updates to the documentation.
  5. Make sure that your code is compiling and all automated tests are passing.

After you have sent Pull Request

  1. Make sure that you applied or answered all the feedback from the maintainers.
  2. We're trying to be as much responsive as we can, but if we didn't respond to you.
  3. Pull request will be merged when you get approvals from at least one of the maintainers (and no rejection from others). Pull request will be tagged with the target Pongo version in which it will be released. We also label the Pull Requests with information about the type of change.

Setup your work environment

We try to limit the number of necessary setup to a minimum, but few steps are still needed:

1. Install the latest Node.js LTS version

Available here.

If you're using NVM you can also call:

nvm install

and

nvm use

To use current recommended version.

2. Install Docker

Available here.

You are now ready to contribute to Pongo.

3. Setup dev environment

You can streamling setup by running setup script:

  • For Linux and MacOS
./setup.sh
  • For Windows
.\buildScript.ps1

Or perform manual steps

3.1. Go to source codes

Source codes are located under ./src/ folder.

cd src

3.2. Install packages

npm install

3.3 Build project

npm run build

3.4. Run tests

npm run test

If any of those steps didn't work for you, please contact us on Discord channel.

Project structure

Pongo is using NPM Workspaces.

The source codes are located in src folder. Packages are nested under ./src/packages folder.

For documentation Pongo is using Vitepress. Documentation is located under ./src/docs folder.

To build documentation locally, run in src folder:

npm run docs:dev

See also other helpful scripts in ./src/package.json.

Working with the Git

  1. Fork the repository.
  2. Create a feature branch from the main branch.
  3. We're not squashing the changes and using rebase strategy for our branches (see more in Git documentation). Having that, we highly recommend using clear commit messages. Commits should also represent the unit of change.
  4. Before sending PR to make sure that you rebased the latest main branch from the main Pongo repository.
  5. When you're ready to create the Pull Request on GitHub.

Code style

Pongo is using the recommended TypeScript, ESLint and Prettier coding style configurations. They should be supported by all popular IDE (eg. Visual Studio Code, WebStorm) so if you didn't disabled it manually they should be automatically applied after opening the solution. We also recommend turning automatic formatting on saving to have all the rules applied.

Licensing and legal rights

By contributing to Pongo:

  1. You assert that contribution is your original work.
  2. You assert that you have the right to assign the copyright for the work.

Code of Conduct

This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community.