from retail

2025-02-09 22:02:20 +01:00
parent 4f98ae597f
commit 0b40284f3f
6 changed files with 18076 additions and 40434 deletions
@@ -0,0 +1,104 @@
+# Contributing to WeakAuras
+
+## Code Standards
+
+There are a few things which we require in any contribution:
+
+- This repository comes with a `.editorconfig` file, so the following requirements will be taken care of if you have [EditorConfig](https://editorconfig.org/) installed:
+  - Tabs consist of 2 spaces.
+  - Files end with a newline.
+  - No trailing whitespace at the end of a line.
+- All user-facing strings (`names` and `desc` fields in AceConfig tables, mostly) must be localized:
+  - We use a locale scraper to find translation phrases and automatically export them to CurseForge for translation. This scraper parses the addon files, looking for tokens that look like: `L["some translation phrase"]`. You must use double quoted strings, and name the localization table (found at `WeakAuras.L`) `L` in your code for this to work properly.
+- When writing a new file, avoid using semicolons. When modifying code in an existing file, try to be consistent, but err on the side of no semicolons.
+- New features should be indicated by concatenating `WeakAuras.newFeatureString` onto the associated translation phrase. We will remove the new feature indicator approximately 3 months after the first release.
+
+## Pull Requests
+
+If you want to help, here's what you need to do:
+
+1. Make sure you have a [GitHub account](https://github.com/signup/free).
+1. [Fork](https://github.com/WeakAuras/WeakAuras2/fork) our repository.
+
+1. Create a new topic branch (based on the `main` branch) to contain your feature, change, or fix.
+
+    ```bash
+    git checkout -b my-topic-branch
+    ```
+
+1. Set `core.autocrlf` to true.
+
+    ```bash
+    git config core.autocrlf true
+    ```
+
+1. Set `pull.rebase`to true.
+
+    ```bash
+    git config pull.rebase true
+    ```
+
+1. Set up your [Git identity](https://git-scm.com/book/en/v2/Getting-Started-First-Time-Git-Setup) so your commits are attributed to your name and email address properly.
+
+1. Take a look at our [Wiki](https://github.com/WeakAuras/WeakAuras2/wiki/Lua-Dev-Environment) page on how to setup a Lua dev environment.
+
+1. Install an [EditorConfig](https://editorconfig.org/) plugin for your text editor to automatically follow our indenting rules.
+
+1. Commit and push your changes to your new branch.
+
+    ```bash
+    git commit -a -m "commit-description"
+    git push
+    ```
+
+1. [Open a Pull Request](https://github.com/WeakAuras/WeakAuras2/pulls) with a clear title and description.
+
+### Keeping your fork updated
+
+- Specify a new remote upstream repository that will be used to sync your fork (you only need to do this once).
+
+  ```bash
+  git remote add upstream https://github.com/WeakAuras/WeakAuras2.git
+  ```
+
+- In order to sync your fork with the upstream WeakAuras repository you would do
+
+  ```bash
+  git fetch upstream
+  git checkout main
+  git rebase upstream/main
+  ```
+
+- You are now all synced up.
+
+### Keeping your pull request updated
+
+- In order to sync your pull request with the upstream WeakAuras repository in case there are any conflicts you would do
+
+  ```bash
+  git fetch upstream
+  git checkout my-topic-branch
+  git rebase upstream/main
+  ```
+
+- In case there are any conflicts, you will now have to [fix them manually](https://help.github.com/articles/resolving-merge-conflicts-after-a-git-rebase/).
+- After you're done with that, you are ready to force-push your changes.
+
+  ```bash
+  git push --force
+  ```
+
+- Note: Force-pushing is a destructive operation, so make sure you don't lose something in the progress.
+- If you want to know more about force-pushing and why we do it, there are a two good posts about it: one by [Atlassian](https://www.atlassian.com/git/tutorials/merging-vs-rebasing#the-golden-rule-of-rebasing) and one on [Reddit](https://www.reddit.com/r/git/comments/6jzogp/why_am_i_force_pushing_after_a_rebase/).
+- Your pull request should now have no conflicts and be ready for review and merging.
+
+## Reporting Issues and Requesting Features
+
+1. Please check our [issue tracker](https://github.com/WeakAuras/WeakAuras2/issues) for your problem since there's a good
+   chance that someone has already reported it.
+1. If you find a match, please try to provide as much info as you can,
+   so that we have a better picture about what the real problem is and how to fix it ASAP.
+1. If you didn't find any tickets with a problem similar to yours then please open a
+   [new ticket](https://github.com/WeakAuras/WeakAuras2/issues/new/choose).
+    - Be descriptive as much as you can.
+    - Provide everything the template text asks you for.