Skip to content

Latest commit

 

History

History
83 lines (60 loc) · 2.79 KB

CONTRIBUTING.md

File metadata and controls

83 lines (60 loc) · 2.79 KB

Contributing to MaterialX Elements

Thanks for checking out MaterialX Elements! This site is all about helping developers and artists learn how to use MaterialX. Every contribution makes the site better, so we’re excited to have your help.

How to Contribute

1. Reporting Issues

If you find something that’s broken or have ideas for improvement, here’s what to do:

  1. Check for Existing Issues: Take a look to see if someone’s already reported the issue.
  2. Create a New Issue: If it’s not there yet, create a new one. Be sure to include:
    • A clear title.
    • Details about the problem or suggestion.
    • Steps to reproduce the issue (if needed).
    • Screenshots, code snippets, or error messages if they’ll help.

2. Contributing

We’d love your help with code, tools, interactive learning features, or better docs!

How to Submit a Pull Request (PR):

  1. Fork the Repository:

    • Hit the "Fork" button at the top of the repo page.

  2. Clone Your Fork:

    git clone https://github.com/your-username/MaterialX_Learn.git
cd MaterialX_Learn

  3. Create a New Branch: Name your branch based on what you’re working on:

    git checkout -b feature/your-feature-name

  4. Make Your Changes:

    • Follow the project’s coding and documentation style.
    • Add comments if needed to explain your changes.
    • Update any relevant documentation.

  5. Run Build Scripts: Make sure everything builds properly. Read the instructions in the the utilities folder for instructions on how to (re)build the site.

  6. Commit Your Changes: Write clear, simple commit messages:

    git add .
git commit -m "Add a detailed description of your changes here"

  7. Push Your Changes:

    git push origin feature/your-feature-name

  8. Open a Pull Request:

    • Go to the original repo.
    • Click "Pull Request" and explain what you’ve done.
    • Link any related issues (e.g., Closes #123).

PR Review Process:

  • A maintainer will review your PR.
  • Be ready to discuss or tweak your changes if needed.
  • Once approved, your PR will be merged into the main branch.

Feel free to follow the same process for documentation updates, too.

Code of Conduct

We want this to be a welcoming space, so please follow these guidelines:

  1. Be Respectful: Treat others with kindness and professionalism.
  2. Be Constructive: Share feedback in a helpful way.
  3. Stay on Topic: Keep discussions relevant to the project.

Any harassment, hate speech, or bad behavior won’t be tolerated.

Contact

Got questions or need some help? Open a discussion or reach out to the maintainers. We’re happy to help!

Thanks again for contributing and helping us make MaterialX Elements even better!