Contributing

Contributions are welcome, and they are greatly appreciated! Every little bit helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/qcoumes/eternaltwin/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your local setup that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "feature" is open to whoever wants to implement it.

Write Documentation

eternaltwinpy could always use more documentation, whether as part of the official eternaltwinpy docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/qcoumes/eternaltwin/issues.

If you are proposing a feature:

• Explain in detail how it would work.
• Keep the scope as narrow as possible, to make it easier to implement.
• Remember that this is a volunteer-driven project, and that contributions are welcome :)

---

Setting up local environment

Ready to contribute? Here's how to set up eternaltwinpy for local development.

1. Fork the eternaltwinpy repo on GitHub.

2. Clone your fork locally:

   • git clone git@github.com:<your_name_here>/eternaltwin.git

3. Run poetry install to install the project dependencies in a virtual environment.

4. Create a branch for local development:

   • git checkout -b name-of-your-bugfix-or-feature

   Now you can make your changes locally.

Testing your changes

Tests must be written inside the tests/ directory.

Some tests need a running Eternaltwin instance. You can up one locally using:

• docker-compose -f docker/docker-compose.yml up --build

Submitting your changes

1. Ensure your code is correctly formatted and documented:

2. poetry run ./bin/lint.sh

3. Commit your changes and push your branch to GitHub:

   git add .
   git commit -m "<type>[scope]: <description>"
   git push origin name-of-your-bugfix-or-feature
   

   We favor the conventional commits format.

4. Submit a pull request through the GitHub website.

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests

2. If the pull request adds functionality, the documentation should be updated.

3. The pull request should pass all checks and tests.