Skip to content

Latest commit

 

History

History
82 lines (68 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

82 lines (68 loc) · 3.87 KB

Contributing to gowebly

TL;DR: sign up for notifications of GitHub Issues and Discussions in main repositories, be courteous, follow the steps below to set up a development environment; if you stick around and contribute, you can join the team (write about yourself to us at [email protected]) and get commit access.

Welcome

We invite you to join our team! Everyone is welcome to contribute code via pull requests, to help people asking for help on issues, or in GitHub Discussions, to help triage, reproduce, or fix bugs that people have filed, to add to our documentation, or to help out in any other way.

We grant commit access (which includes full rights to the issue database, such as being able to edit labels) to people who have gained our trust and demonstrated a commitment to gowebly project.

We communicate primarily over GitHub and email ([email protected]).

See also: the Code of conduct of the project.

Helping out in the issue database

If you want to help us triage, you are very welcome to do so!

  1. Sign up for notifications of new Issues and Discussions in this organization's main public repositories: gowebly and gowebly helpers.
  2. Read our code of conduct, which stipulates explicitly that everyone must be gracious, respectful, and professional. If you're helping out with triage, you are representing the gowebly project team, and so you want to make sure to make a good impression!
  3. Once you've been doing this for a while, someone will invite you to the gowebly-contributors team on GitHub, and you'll be able to add labels too.

Developing for gowebly

To develop for the gowebly project, you will eventually need to become familiar with our processes and conventions. This section lists the documents that describe these methodologies. The following list is ordered: you are strongly recommended to go through these documents in the order presented.

  1. Our code of conduct, which stipulates explicitly that everyone must be gracious, respectful, and professional. This also documents our conflict resolution policy and encourages people to ask questions.
  2. Strict following all community and developer-accepted style guides for the technologies and frameworks used in all gowebly projects. Technologies: Go, Docker, htmx, hyperscript; Go frameworks: Fiber, Echo, chi; CSS frameworks: Tailwind CSS, UnoCSS.
  3. Communication is in English (US). If this is not your native language, please use translators and text helpers when writing text (comments in code, PR descriptions, answers in Issues or Discussions, and so on). We ourselves use LanguageTool, DeepL and Code Spell Checker for VS Code and Grazie lite for JetBrains IDEs.