Skip to content

Latest commit

 

History

History
137 lines (78 loc) · 8.27 KB

CONTRIBUTING.md

File metadata and controls

137 lines (78 loc) · 8.27 KB
Raw

Contributing

Hi there 👋, we're excited 🤗 that you're interested in contributing to Configu! Your contributions enrich the Configu experience and make it better every day 🤩.

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

We ask all contributors to abide by our Code of Conduct. This helps ensure a positive and productive environment for everyone.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Bugs and Improvements

We use the issue tracker to keep track of bugs and improvements to Configu itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.

Getting Help

For support or usage questions like “how do I do X with Configu” and “my code doesn't work”, please search and ask on Stack Overflow with a Configu tag first.

We ask you to do this because StackOverflow has a much better job at keeping popular questions visible. Unfortunately good answers get lost and outdated on GitHub.

Some questions take a long time to get an answer. If your question gets closed, or you don't get a reply on Stack Overflow for longer than a few days, we encourage you to post an issue linking to your question. We will close your issue but this will give people watching the repo an opportunity to see your question and reply to it on StackOverflow if they know the answer.

Please be considerate when doing this as this is not the primary purpose of the issue tracker.

Help Us Help You

On both websites, it is a good idea to structure your code and question in a way that is easy to read to entice people to answer it. For example, we encourage you to use syntax highlighting, indentation, and split text in paragraphs.

You can make it easier for us if you provide versions of the relevant libraries and a runnable small project or test case reproducing your issue.

Development

This repository is a monorepo. This means there are multiple packages managed in this codebase, even though we publish them as separate packages.

It is powered by node.js and npm and uses husky and lint-staged to enforce its coding guidelines.

To see the full list of prerequisites, check out the devEngines property in the main package.json file.

Cloud environments

Instantly start experimenting and developing.

Open in GitHub Codespaces

Open in CodeSandbox →

Local environment

  • Install git
  • Install Node.js and Npm according to the .nvmrc file.
  • Install monorepo dependencies by running npm i in the root directory.
    • Alternatively, bootstrap the whole monorepo by running .devcontainer/bootstrap.sh script in the root directory.

Repository Structure

.

The root directory serves as the skeleton for the Configu project and provides the resources needed for developers to build and contribute to it.

./types

The ./types directory holds the core types of the Configu project. These types are written in TypeScript, and then converted into strongly-typed models and serializers in various programming languages using quicktype. These core types serve as the foundation for all Configu SDKs.

Running npm i in the root directory triggers type generation of the various supported SDKs.

./examples

The ./examples directory demonstrates various concepts and best practices with some real-world use-cases of Configu.

documentation

The documentation repository holds the official Configu docs. Improvements to the documentation are always welcome. We use Gatsby to build our documentation website. The website is published automatically whenever the main branch is updated.

./ts

The ./ts directory houses a sub-monorepo that includes the following packages:

./py

The ./py directory houses the Python SDK that is powered by Poetry.

./go

The ./go directory houses the Go SDK.

Sending a Pull Request

For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgment!

In general, the contribution workflow looks like this:

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the main branch.
  • Make sure all tests pass and there are no linting errors.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Resources

Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.

Thank you 💙 for considering contributing to Configu! We look forward to working with you 🤝.