Skip to content

Latest commit

 

History

History
83 lines (59 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

83 lines (59 loc) · 2.79 KB

Contributing to World Modeling Language (WML)

Thank you for your interest in contributing to World Modeling Language (WML)! We appreciate your help and look forward to collaborating with you.

How to Contribute

Reporting Issues

If you find a bug or have a feature request, please create an issue on the GitHub Issues page. Provide as much detail as possible, including steps to reproduce the issue and any relevant screenshots.

Submitting Pull Requests

  1. Fork the repository: Click the "Fork" button at the top right of the repository page to create a copy of the repository on your GitHub account.

  2. Clone your fork:

    git clone https://github.com/yourusername/WML.git
cd WML

  3. Create a new branch:

    git checkout -b your-branch-name

  4. Make your changes: Implement your changes in the new branch.

  5. Commit your changes:

Implement your changes in the new branch. Write clear and concise commit messages following the Conventional Commits standard. Examples of Conventional Commit messages:

  • feat: add new simulation module

  • fix: resolve issue with data import

  • docs: update contributing guidelines

  • refactor: improve code readability

  • test: add unit tests for entity class

  • chore: update dependencies

  • style: format code according to PEP 8

  • ci: configure continuous integration pipeline

  • perf: optimize simulation performance

  • build: compile source code

  • revert: undo previous commit

    git add .
git commit -m "type: description"

  1. Push your changes:

    git push origin your-branch-name

  2. Open a pull request: Navigate to the original repository and click on the "New Pull Request" button. Select your branch and provide a detailed description of your changes.

Coding Guidelines

To ensure consistency and readability, please follow these coding guidelines:

  • Write clear and concise commit messages following the Conventional Commits standard.
  • Follow the project's coding style.
  • Include comments and documentation where necessary.
  • Write tests for new features and bug fixes.

Code of Conduct

By participating in this project, you agree to abide by our Code of Conduct. Please read it to understand the standards of behavior expected from contributors.

License

By contributing to WML, you agree that your contributions will be licensed under the terms specified in the LICENSE file.

Getting Help

If you have any questions or need help with contributing, please feel free to reach out by opening an issue or contact me.