leifericf

leifericf

I think it could be useful to gather some of our communal thoughts and notes on how to contribute to open source Elixir projects. Including dos and don’ts, common practices, etc.

This could serve as a starting point for people who are new to Elixir and perhaps even to programming in general. How can we help our new friends to hit the ground running?

We could include general things, such as:

  • Cloning a development version of a library from GitHub.
  • Testing one’s changes before submitting a pull request.
  • “Squashing” commits before submitting a pull request.
  • Submitting a pull request to open source projects.

Those topics, which are not specific to Elixir, might be covered elsewhere. If so, then maybe we can reference other sources and/or create an index of useful resources.

There might also be some Elixir-specific aspects, such as:

  • Including a development version of a library in an applicatoin for testing.
  • Best practices when it comes to implementing tests.
  • Steps to take before submitting a pull request, e.g. running tests, code formatter, etc.

Those are just some suggestions to get the conversation going.

What do you think? Is this a good idea or a bad idea? Do you have any suggestions?

Such things may of course vary a great deal from project to project, depending on how the particular project is set up, but perhaps there are some basics things most of them have in common.

First 2 of 2 Posts Switch mode

joaquinalcerro

joaquinalcerro

This is Avery interesting topic. Please checkout this thread:

You can check this excellent post on this issue:

Hope this helps.

Best regards.

kelvinst

kelvinst

Heeey. I have being doing livestreams while contributing to elixir open-source projects, so maybe useful for you:

— All posts loaded —

Where Next? Top

Trending in Discussions Top

AstonJ
As the title says, please share what you’ve been up to with Elixir. Whether that’s been learning it, looking into it, making stuff with i...
2977 91898 914
New
AstonJ
The obligatory hello world thread! Who are you and where are you from? :stuck_out_tongue:
4616 55835 594
New
byu
@chrismccord : I just saw the Extract AGENTS.md from Phoenix.new into phx.new generator commit to the phoenix project. My initial shotgu...
New
arcanemachine
I was working on an Ecto migration and I needed a timestamp. So, for the nth time, I looked up the different data types for timestamps, a...
New
AstonJ
Just a general thread to post chat/news/info relating to AI/ML stuff that may be relevant for Nx now or in the future. Got anything to sh...
New
juhalehtonen
There has been a thread to discuss the Stack Overflow Developer Survey on this forum every year since 2018, so here’s yet another one for...
New
type1fool
I just stumbled on a newly redesigned elixir-lang.org. :tada: It looks like @Software_Mansion did the work, and I think it is generally a...
New

Other Trending Topics Top

JesseHerrick
Hey, I’m Jesse and I’m the main contributor behind Dexter, a full-featured, lightning-fast Elixir LSP optimized for large codebases. It s...
New
jimsynz
Beam Bots (or just BB for short) is a framework for building fault-tolerant robotics applications in Elixir using familiar OTP patterns. ...
New
Damirados
Hello everyone. After busy few months I am happy to announce v0.1.0 of Emerge & Solve. They are GUI (Emerge) and State management (S...
New
netoum
Corex is an accessible, unstyled UI component library for Phoenix that integrates Zag.js state machines using Vanilla JavaScript and Live...
New
ausimian
Emily is an Elixir library that runs Nx computations on Apple’s MLX. Install it as the default Nx backend and Nx, defn, Axon, Nx.Serving,...
New
mudasobwa
While I am working on the Language Agnostic Code Audit SaaS, which uses MetaAST (spoiler: I am expecting it to be in a good shape for ann...
New

We're in Beta

About us Mission Statement