Contributing

Instructions:

1. Fork the repository.

2. Clone the repo:

   git clone https://github.com/YOUR_USERNAME/synax
   cd synax
   

3. Perform an editable installation:

   pip install -e ".[dev,docs]"
   

4. Add the original repo as an upstream remote:

   git remote add upstream https://github.com/carlosgmartin/synax
   

5. Create a branch:

   git checkout -b name-of-change
   

6. Implement your change.

7. Lint, typecheck, and run tests:

   ruff check && ruff format && pyright && pytest
   

8. If you have edited the documentation, build and preview it:

   sphinx-build -M html docs docs/_build
   open docs/_build/html/index.html
   

9. Add the files you have modified and create a commit:

   git add file1.py file2.py ...
   git commit -m "Your commit message."
   

10. Sync your code with the original repo, resolving any conflicts:

    git fetch upstream
    git rebase upstream/master
    

11. Push your commit:

    git push --set-upstream origin name-of-change
    

12. Go to the repo and create a pull request.