Contributing to SceneFun3D¶

Thank you for considering contributing to SceneFun3D! We welcome all contributions, whether it's bug fixes, feature additions, documentation improvements, feature suggestions, or any other enhancement.

How to Contribute¶

1. Fork the Repository¶

Start by forking the repository you want to contribute to and cloning it to your local machine:

git clone https://github.com/SceneFun3D/scenefun3d.git
cd scenefun3d

git clone https://github.com/SceneFun3D/documentation.git
cd documentation

2. Create a New Branch¶

Always create a new branch to work on, based on the main branch:

git checkout -b feature/your-feature-name

3. Make Changes¶

Make your desired changes. Ensure your code follows the project's style and conventions.

4. Write Tests¶

If applicable, write tests for your changes to ensure everything works as expected. Ensure all tests pass before submitting.

5. Commit Your Changes¶

Make meaningful, well-documented commit messages. Use your preferred name for Git commits.

git commit -m "Add feature description"

6. Push to Your Fork¶

Push your branch to your forked repository:

git push origin feature/your-feature-name

7. Open a Pull Request¶

Go to the original repository and open a pull request. Provide a clear and concise description of your changes, referencing any related issues or discussions.

Feedback and Support¶

We appreciate all feedback! Feel free to open an issue if you have questions or need assistance.