Skip to content

Latest commit

 

History

History
63 lines (40 loc) · 2.82 KB

CONTRIBUTING.md

File metadata and controls

63 lines (40 loc) · 2.82 KB

Contributing to hubi

Thank you for being here 🎉!

Code of Conduct

This project and everyone participating in it is governed by its Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

Contributions

Even non-code contributions, may require you to open an issue. Use this template to help us even more.

You don't need to code to help us

You can do all below in any order you want, as much as you like

  • Give us some feedback about non-clear documentation
  • Give us some feedback about ridiculous overcomplicated contributing rules
  • Tell us about typos on docs, ubiquitous language and/or code
  • Tell us about inaccurate use of our own ubiquitous language - we are currently evolving it so it may change a bit
  • Star ⭐ hubi on github
  • Provide us assets (images, gifs, wireframes, etc) to enhance something you think should be enhanced e.g. HTML generated by the site translator
  • Tell your friends about us if you've liked the project
  • Tell your enemies about us if you've hated it - because they deserve some suffering!
  • Show us to people who are either friends nor enemies
  • Issue bugs and/or miss behaviors
  • Issue ideas and/or feature requests
  • Tell us showcases
  • Help us with logos and translations

But of course you want to help us with some coding

Open up a pull request after one of the issues on our dynamic roadmap.

You are not required, but it would be nice to be familiar with hubi's ubiquitous language in order to write some quality code.

I want to do something that is not on the roadmap

You can! We are open-source, eh?

Check for feature requests as someone may be already working on something similar to it, and you may help each other. In case you don't find anything like your idea/feature, issue one.

PR process

  1. You'll need to fork hubi
  2. Branch of from the last major version, naming your branch after the issue
  3. Make your changes
  4. Issue a pull requst compliant with its template
  5. Wait for merging

Known issues

  • You may have to manually create a .nyc_output folder at root level so your coverage can be run.

Release

This repo uses semantic release configured on CI to deploy withouth human intervation.

When a pull request is merged into master, the release process kicks.

Contributions not mentioned here

Contact us at [email protected], and communicate what you're plannning.