Skip to content

Latest commit

 

History

History
56 lines (41 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

56 lines (41 loc) · 1.64 KB

Contributing

Thanks for helping to make Diffusion-UI awesome!

We welcome all kinds of contributions:

  • Bug fixes
  • Documentation improvements
  • New features
  • Refactoring & tidying

Getting started

If you have a specific contribution in mind, be sure to check the issues and pull requests in progress - someone could already be working on something similar and you can help out.

Coding guidelines

Some tools are used to ensure a coherent coding style. You need to make sure that your code satisfy those requirements or the automated tests will fail.

  • eslint

To use the linter to fix your code, run:

npm run lint

Pre-commit hook

If you want to automatically verify that the linting is respected at every commit, you can put this at the end of a .git/hooks/pre-commit file:

exec npm run lintcheck

How to create a good Pull Request

  1. Make a fork of the main branch on github
  2. Clone your forked repo on your computer
  3. Create a feature branch git checkout -b feature_my_awesome_feature
  4. Modify the code
  5. Verify that the Coding guidelines are respected
  6. Make a commit and push it to your fork
  7. From github, create the pull request. Automated tests from GitHub actions will then automatically check the code
  8. If other modifications are needed, you are free to create more commits and push them on your branch. They'll get added to the PR automatically.

Once the Pull Request is accepted and merged, you can safely delete the branch (and the forked repo if no more development is needed).