Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (32 loc) · 3.45 KB

CONTRIBUTING.md

File metadata and controls

54 lines (32 loc) · 3.45 KB
Raw

Contributing to ATmosphere

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Developers of all levels can help — whether you can barely recognize a filter (or don’t know what that means) or you’ve already authored your own plugins, there are ways for you to pitch in.

Create Bug Reports

If you find a bug, please use our bug report form. This helps us gather the information we need efficiently.

Keep your bug reports focused and actionable:

  • Include specific steps to reproduce the issue.
  • Provide the URL of the page that has the bug.
  • Describe what you expected to see and what happened instead.
  • Stay within the plugin's scope—issues unrelated to ATmosphere functionality may be closed.

If you have write access, add the appropriate labels.

Write and submit a patch

If you'd like to fix a bug or make an enhancement, you can submit a Pull Request. Before you get started, you'll want to set up your development environment.

Once your development environment is ready, you can get started and create your first Pull Request!

Get started

If you'd like to contribute but don't know where to get started, you can take a look at existing issues:

  • "Good First Issues" are a good entry point to get familiar with the ATmosphere plugin's code base.
  • All issues labeled with the "Good For Community" label are fair game. That's a great way to contribute new features and fix small issues within the ATmosphere plugin.

We're Here To Help

We encourage you to ask for help at any point. We want your first experience with the ATmosphere plugin to be a good one, so don't be shy.

For questions and discussions:

  • Use GitHub Discussions for feature ideas, general questions, and open-ended topics.
  • Create issues only for specific bugs or concrete enhancement proposals.
  • Keep questions concise and directly related to the plugin.

This helps us organize feedback effectively and ensures your questions get the right attention.

Translate the plugin

If you speak a foreign language, you can help translate the ATmosphere plugin into your own language. Here is how to get started with translating.

License

The ATmosphere plugin is licensed under the GPL-2.0-or-later license.

All materials contributed should be compatible with the GPLv2 license. This means that if you own the material, you agree to license it under the GPLv2 (or later) license. If you are contributing code that is not your own, such as adding a component from another Open Source project, or adding an npm package, you need to make sure you follow these steps:

  1. Check that the code has a license. If you can't find one, you can try to contact the original author and get permission to use, or ask them to release under a compatible Open Source license.
  2. Check the license is compatible with GPLv2, noting that the Apache 2.0 license is not compatible with GPLv2.