Skip to content

Latest commit

 

History

History
210 lines (139 loc) · 12.2 KB

File metadata and controls

210 lines (139 loc) · 12.2 KB

Support and Help

FAQs, credit and fund info, legal notices and all the other support information you might need! 🐰

List of Contents

This article explains where to get help with remark. Please read through the following guidelines.

👉 Note: before participating in our community, please read our Code of Conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

Need help getting started or using a project? Here's how.

🔔 How to Get Help

Generally, we do not use GitHub as a support forum. For any usage questions that are not specific to the project itself, please ask on Stack Overflow instead. By doing so, you are more likely to quickly solve your problem, and you will allow anyone else with the same question to find the answer. This also allows maintainers to focus on improving the project for others.

Please seek support in the following ways:

  1. 📖 Read the documentation and other guides for the project to see if you can figure it out on your own. These should be located in a root docs/ directory. If there is an example project, explore that to learn how it works to see if you can answer your question.

  2. 💡 Search for answers and ask questions on Stack Overflow. This is the most appropriate place for debugging issues specific to your use of the project, or figuring out how to use the project in a specific way.

  3. 📝 As a last resort, you may open an issue on GitHub to ask for help. However, please clearly explain what you are trying to do, and list what you have already attempted to solve the problem. Provide code samples, but do not attach your entire project for someone else to debug. Review our contributing guidelines.

📖 Code of Conduct

Please review our Code of Conduct. It is in effect at all times. We expect it to be honored by everyone who contributes to this project. Acting like an asshole will not be tolerated.

Examples of encouraged behavior that contributes to a positive environment include:

  • Using welcoming and inclusive language
  • Being respectful of differing viewpoints and experiences
  • Gracefully accepting constructive criticism
  • Focusing on what is best for everyone at the event
  • Showing empathy towards other participants

Unacceptable behavior includes:

  • The use of sexualized language or imagery, or inappropriate physical contact, sexual attention, or advances
  • Trolling, insulting or derogatory comments, personal or political attacks, or sustained disruption of talks or other events
  • Deliberate intimidation, stalking, following, or harassing photography or recording
  • Harassment of any kind, even in a joking or ironic manner
  • Other conduct which could reasonably be considered inappropriate in a professional setting

Be kind to others. Do not insult or put down other attendees. Behave professionally. Remember that harassment and sexist, racist, or exclusionary jokes are not appropriate at this event.

📥 Issues and Bug Reports

DO NOT use the issue tracker to ask questions; use chat or the forums for that. Questions posed to the issue tracker will be closed.

All open-source project uses GitHub Issues to track bugs and feature requests. Please search the existing issues before filing new issues to avoid duplicates. For new issues, file your bug or feature request as a new Issue.

When reporting an issue, please include the following details:

  • A narrative description of what you are trying to accomplish.
  • The minimum code necessary to reproduce the issue.
  • The expected results of exercising that code.
  • The actual results received.

For activity of report may ask for additional details: what version of the library you are using, and what IDE version was used to reproduce the issue.

You may also submit a failing test case as a pull request

💡 Asking Quality Questions

Questions can go to GitHub discussions.

Help us help you! Spend time framing questions and add links and resources. Spending the extra time up front can help save everyone time in the long run. Here are some tips:

  • Talk to a duck!
  • Don’t fall for the XY problem
  • Find the best answer to your technical question, help others answer theirs in stackoverflow
  • Search to find out if a similar question has been asked
  • Try to define what you need help with:
    • Is there something in particular you want to do?
    • What problem are you encountering and what steps have you taken to try and fix it?
    • Is there a concept you don’t understand?
  • Provide sample code, such as a CodeSandbox or video, if possible
  • Screenshots can help, but if there’s important text such as code or error messages in them, please also provide those as text
  • The more time you put into asking your question, the better we can help you

These are not appropriate avenues for seeking help or support with an open-source project. Please follow the guidelines in the previous section. Public questions get public answers, which benefits everyone in the community. ✌️

🍷 Contributions and Supports

If you want to contribute to a project and make it better, your help is very welcome. Contributing is also a great way to learn more about social coding on Github, new technologies and and their ecosystems and how to make constructive, helpful bug reports, feature requests and the noblest of all contributions: a good, clean pull request.

With pleasure to accept your patches and contributions to various open-source or software projects. There are just a few small guidelines you need to follow before making a change.

See contributing.md on how to contribute.

💳 Funds and Credits

Written by @wiefunkdai <stephanusdai.web.id>.

Please feel free to adopt this guide in your own projects. Fork it wholesale or remix it for your needs.

I open-source almost everything I can and try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.

However, if you are using this project and are happy with it or just want to encourage me to continue creating stuff, there are a few ways you can do it:

  • Giving proper credit on the GitHub Sponsors page. Static Badge
  • Starring and sharing the project ⭐
  • You can make one-time donations via PayPal. I'll probably buy a coffee ☕ or tea 🍵 or cake 🍰
    paypal.me/wiefunkdai
  • It’s also possible to support mine financially by becoming a backer or sponsor through
    opencollective.com/wiefunkdai

📝 Legal License

License of Free Open Sources

All Free Open Sources are provided by me under the terms of the following BSD-3 Clause License.

You must retain the original copyright notice shown on the left. You can to use freely for commercial purposes in derivative works, modify, Distribute, place a warranty on the software. And also you can Give partial production or distribution rights to third parties not included in the license. Can not use contributors' names, logos or trademarks. And also can not Software is released without warranty and the software/license owner cannot be charged for damages.

License of Official and User-contributed Documentation

The text contained in the official and user-contributed project documentation as stated as other content on project, except the license projects or documents themselves and as otherwise noted, is licensed under the Creative Commons Attribution 4.0 International (CC-BY-4.0).

You must give appropriate credit, provide a link to the license, and indicate if changes were made. All may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use. If you remix, transform, or build upon the material, you must distribute your contributions under the same license as the original. No additional restrictions, You may not apply legal terms or technological measures that legally restrict others from doing anything the license permits.

🌏 Others

However, I am available for hire. For details on contracting and consulting, or you can also give me career opportunities to help your business in developing the software you need. Please contact me at:
wiefunk@stephanusdai.web.id t.me/wiefunkdai linkedin.com/in/wiefunkdai

Author Description

@wiefunkdai

• Name : Stephanus Bagus Saputra ( 戴 Dai 偉 Wie 峯 Funk )
• Email : wiefunk@stephanusdai.web.id
• Link : https://stephanusdai.web.id

🙏 Thanks for your contribute and support! 😍 ❤️


Visit Website · Global Issues · Global Discussions · Global Wiki

Copyright © ID 2023 Stephanus Bagus Saputra (www.stephanusdai.web.id)
All rights reserved.