Skip to content

Latest commit

 

History

History
77 lines (55 loc) · 4.36 KB

CONTRIBUTING.md

File metadata and controls

77 lines (55 loc) · 4.36 KB
Raw

Creative Commons License

Content

  1. Code of Conduct
  2. Issues
  3. Pull Requests
  4. Commits
  5. Credits

Code of Conduct

  • Think before you react. If you disagree strongly, consider giving it a few minutes before responding.

  • Ask questions, don't make demands. ("What do you think about trying...?" rather than "Don’t do...!!!")

  • Don't insult. Avoid using terms that could be seen as referring to personal traits. ("dumb", "stupid"). Assume everyone is attractive, intelligent, and well-meaning.

  • Be explicit. Remember people don't always understand your intentions online.

  • Don't use hyperbole. ("always", "never", "endlessly", "nothing")

  • Use emoji to clarify tone. (":sparkles::sparkles: Looks good :+1: :sparkles::sparkles:" rather than "Looks good.")

Issues

We are no longer using the GitHub Issue Tracker. Please use the Wurst Feedback App instead.

Pull Requests

Note: There haven't been many Pull Requests yet, so these guidelines are mostly based on predictions rather than experience.

  • Read the tutorial if you have never forked a repository before.

  • Fork the repository and clone it locally.

  • Pull in changes from the original often so that you stay up to date. That way, when you submit your pull request, merge conflicts will be less likely.

  • Create a branch for your edits.

  • Be clear about what problem is occurring and how someone can recreate that problem or why your feature will help. Then be equally as clear about the steps you took to make your changes.

  • It’s best to test. Run your changes against any existing tests if they exist and create new ones when needed. Whether tests exist or not, make sure your changes don’t break the existing project.

  • Include screenshots of the before and after if your changes include visible differences. Drag and drop the images into the body of your pull request.

  • Keep the style of the project to the best of your abilities. This may mean using indents, semi colons or comments differently than you would in your own repository, but makes it easier for the maintainer to merge, others to understand and maintain in the future.

Commits

  • Use present tense & imperative mood.
    • "Add feature" ✅ good
    • "Added feature" ❌ bad
    • "Adds feature" ❌ bad
  • Consider starting the commit message with an applicable emoji:
    • 🐛 :bug: when fixing bugs
    • 🚀 :rocket: when improving performance
    • 💎 :gem: when cleaning up code
    • 📝 :memo: when writing docs
    • 📊 :bar_chart: when dealing with Google Analytics
    • 🎨 :art: when designing GUIs etc.
    • 🔒 :lock: when dealing with security
  • When fixing/implementing Issues, include the Issue number. That will close the Issues automatically.
    • "Fix #272" (for bugs) ✅ good
    • "Resolve #272" (for features) ✅ good
    • "Fix error in .nuker that was reported in #272" ❌ bad
  • When fixing anonymous error reports (Wurst v1.12 and higher), include the ID.
    • "Fix error report mosz7w34tmagrh8qw3mngwwmn5ww" ✅ good
    • "Fix an error I found on wurst-client.tk/error-reports" ❌ bad

Credits

Creative Commons License

These guidelines by Alexander01998 are licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

These guidelines are partially based on the following guides and guidelines: