Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 6.06 KB

CONTRIBUTING.md

File metadata and controls

95 lines (65 loc) · 6.06 KB
Raw

Firstly, thank you for being here! We appreciate you ❤️

Table of Contents

Let's Be Efficient!

Our top priority is to hopefully avoid wasting anyone's time/effort (including yours!) on items that may eventually not be used. We want to spend time/effort on things that get implemented!

Here are three steps to being efficient:

  • 1️⃣ Obtain context on the greater vision 🔭 before beginning work to make sure you contribution will be accepted;
  • 2️⃣ Get a consultation on that grand new idea you may have 🤔 before implementing anything to see if it is something that is wanted;
  • 3️⃣ Use the advice we give you to ensure that anything you contribute works well with all the moving pieces🏗.

Often these discussions end up very, very fascinating and land us in elegant solutions we could not have predicted.

Discussions via Matrix

Our base of operations for group discussions on this project is our Matrix chat room: Jupiter Web Site on Matrix

FAQ:

I want to help, what should I work on?

❗ Note: Please do a quick search prior to opening an issue - maybe a relevant issue already exists. 😉

  • 🚀 The current focus and priority is on Milestone 1.0
  • 📝 You can submit an idea or a feature by opening an issue.
  • 💡 When you feel inspired about a particular issue or feature, please propose your implementation idea/strategy for approval via the issue comments, which indicates you are dedicated to solving this issue, thus avoiding duplication of effort.
  • 💪 If you have a particular skillset, feel free to focus there.
  • 🚩 Some tickets are specifically labeled "low priority", but others are so far of fairly equal importance. Any time there is something clearly urgent, the "urgent" tag will be used.

How do I assign an issue to myself?

  • 🔑 The key is to communicate enough to avoid unnecessary duplication of effort, which has already happened, unfortunately.
  • 🗨 Comment on an issue to signal your intentions and interest. The important thing is to communicate your intention and progress so we can help you find success. And, as we've seen already, it seems like when there's movement on a ticket we all get inspired. Progress is wonderfully contagious! ✨

What is the Pull-Request (PR) etiquette?

  • 💻 Don't be shy, creating a Work-In-Progress (WIP) PR is a great way to get some feedback and maybe some direction for your work.
  • ✅ Create a markdown checklist to indicate what's done and what's still missing (see this example).
  • ⚙ If you are closing a specific issue we encourage you to use Github's closing keywords to automatically close the issue once the PR is merged.
  • 🚮 Feel free to delete your feature branch after it has been merged via the PR. There’s a handy button on the GitHub interface, and in the worst case they can be reverted easily.
  • 🎯 We currently use a develop branch as our default, so expect your PRs to target develop and not the otherwise standard main branch
  • 🚀 We've also integrate PR deploy previews for the current develop branch - see the Environment section of the repo's main page sidebar. All PRs also get their own unique deploy previews found as a comment under the respective PR.

What is the stack used for the site?

  • Hugo - static site generator
  • Bulma - frontend framework for UI componenets

I don't see a package.json file, why don't you use npm/yarn?

  • There was a deliberate choice not to integrate npm/yarn.
  • It makes it easier to start contributing - all that's required is the Hugo binary.
  • The goal is to keep the site simple and fast - this means having as few dependecies as possible.
  • The third-party libraries are saved directly into the repo.
  • All of this is subject to change if there is a good reason for it.

How do I style my UI components?

  • Please try to use Bulma as much as possible for all your frontend needs. It has a great documentation and is easy to grasp quickly. You can probably achieve everything you need using the Bulma CSS classes.
  • Try and use the color variables defined in _variables.sass
    • Some of the colors have multiple aliases for convenience.
    • All of these colors have been set-up for use with Bulma modifiers syntax, here are some examples: 
      <button class="button is-primary">is-jb-pink</button>
<button class="button is-jb-pink">is-jb-pink</button>
<button class="button is-lup-blue">is-lup-blue</button>
  • If you end up not finding what you need there, or need to build something on top of Bulma, your CSS (technically SASS) would go into this directory.
    • Please try and follow the existing structure as an example.

Other than that - have fun! 🐧

...and don't be shy - gitmoji.dev 🌱