Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.58 KB
Raw

Contributing

Contribute to prompting

Feel like our codebase is missing a feature? We welcome your pull requests!

Issues labeled good first issue can be good first contributions, and will help get you familiar with the codebase.

Few pointers for contributions:

  • Create your PR against the staging branch, not main.
  • New features need to contain unit tests, must conform to CI/CD style guides and should be documented with the introduction PR.
  • PR's can be declared as Draft - which signify Work in Progress Pull Requests (which are not finished).

If you are unsure, discuss the feature on our SN1 server (alpha) or in an issue before a Pull Request.

Before sending the PR

1. Run pre-commit hook

All unit tests, linters, and formatters must pass. If something is broken, change your code to make it pass. It means you have introduced a regression or violated the code style.

poetry run pre-commit run --all-files

2. Run validator on testnet

Run validator on testnet and analyze the logs for any potential issues.

# Modify .env.validator with the required fields.
bash install.sh && bash run.sh

Creating the PR

1. Write concise PR description

Recommended example of template for PR description:

## Changes
  - Add some new feature;
  - Fix issue with some function;
  - Implement new sorting algorithm.

2. Check remote CI/CD PR status

All Github Actions checks must pass.