From 24c6afff9b732a6d31a69212e6d0ac5950defdfe Mon Sep 17 00:00:00 2001 From: Ilian Iliev Date: Sat, 4 May 2024 19:30:28 +0300 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f8e3c8c --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,43 @@ +# Contributing + +First off, thank you for considering contributing. It’s people like you who make Stable Diffusion such a great tool. + +## Getting Started + +Before you begin, make sure you have a GitHub account and that you have forked the repository to your own GitHub account. Clone it to your local machine to begin making changes. + +## Making Changes + +Here's a quick rundown of how you should go about making a change: + +1. **Create your own branch** from `develop`: +Avoid making changes in the `develop` branch directly. Instead, create a new branch for your changes. Use a short, descriptive name for your branch, like `feature-enhance-ui` or `bugfix-ui-state-save`. + +2. **Make your changes**: +Implement your changes, adhering to the coding conventions and standards. + +3. **Commit your changes**: +Make sure your commit messages are clear and follow the best practices. E.g., "Add feature to ..." or "Fix issue with ..." + +4. **Pull the latest changes from `develop`**: +Before submitting a pull request, make sure your branch is up to date with the latest changes in the `develop` branch. + +5. **Push your changes**: +Push your changes to your fork on GitHub. + +6. **Submit a pull request**: +Open a pull request from your branch to the `develop` branch of the original repository. Provide a concise and informative title and description for your pull request. Link any relevant issues. + +## After Your Pull Request is Merged + +Once your pull request is merged, you might want to clean up your branches and pull the latest changes from the main repository to ensure your local copy is up-to-date. + +## Additional Guidance + +- If you're not sure where to start, look for open issues labeled "good first issue" or "help wanted." + +- Feedback and constructive criticism are always welcome. We’re looking to learn and improve. + +- If you're looking for a specific way to contribute, reviewing pull requests is a great place to start. + +Thank you for contributing! Your efforts help improve the experience for everyone using the extension.