Skip to content

Latest commit

 

History

History
83 lines (51 loc) · 3.59 KB

CONTRIBUTING.md

File metadata and controls

83 lines (51 loc) · 3.59 KB

Contributing to Simpla

Thank you for taking the time to contribute! ❤️ 🎉

Important!

By contributing to this project, you:

  • Agree that you have authored 100% of the content
  • Agree that you have the necessary rights to the content
  • Agree that you have received the necessary permissions from your employer to make the contributions (if applicable)
  • Agree that the content you contribute may be provided under the Project license(s)

Code of Conduct

This project and everyone participating in it is governed by Simpla's Code of Conduct. By participating, you are expected to uphold this code. Please report any unacceptable behavior you see.

Getting started

Creating an issue is the simplest form of contributing to Simpla. But there are many ways to contribute, including the following:

  • Feature requests
  • Bug reports
  • Creating new Simpla components
  • Submitting pull requests

Showing support for Simpla

Open source software is built by people like you, who spend their free time creating things the rest the community can use.

Don't have time to contribute? No worries, here are some other ways to show your support for Simpla:

  • Star the project
  • Tweet your support for Simpla
  • Share the project website

Simpla's ecosystem

Simpla is a large open source project made up of dozens of repositories. The core library provides low-level tools for both developers and Simpla elements to save content, manage state, coordinate changes, authenticate users, and react to content updates.

The majority of Simpla's user-facing functionality comes from its content components. All Simpla's components are open-source and uphold the same contributing and code of conduct guidelines as this library.

Issues

Before creating an issue

Please try to determine if the issue is caused by a) one of Simpla's elements, or b) an underlying library, and if so create an issue there. Sometimes this is difficult to know, we only ask that you attempt to give a reasonable attempt to find out.

Try to follow these guidelines

  • Avoid creating issues for implementation help. It's much better to keep the issue tracker focused on bugs and feature requests, ask implementation questions on Stack Overflow.
  • Investigate the issue
  • Create the issue in the appropriate repository

Creating an issue

Please be as descriptive as possible when creating an issue. Give us the information we need to successfully answer your question or address your issue by answering the following in your issue:

  • Description of the issue
  • Steps to reproduce the problem
  • The browsers that are effected
  • Your environment (Simpla version, other frameworks used)

Closing issues

The original poster or the maintainers of Simpla may close an issue at any time. Typically, but not exclusively, issues are closed when:

  • The issue is resolved
  • The project's maintainers have determined the issue is out of scope
  • An issue is clearly a duplicate of another issue, in which case the duplicate issue will be linked.
  • A discussion has clearly run its course

Pull requests

Before submitting a pull request, ensure that the change it makes addresses an existing issue or feature request, or has been discussed with the maintainers.

  • Fill in the required template
  • Do not include issue numbers in the PR title
  • Ensure all tests are passing, and write new tests for added functionality

New elements

One of the best ways to contribute to the Simpla project is by creating your own Simpla elements! We're planning much more thorough documentation for this soon.