Skip to content

contributing.md

Latest commit

 

History

History
68 lines (43 loc) · 2.94 KB

contributing.md

File metadata and controls

68 lines (43 loc) · 2.94 KB

Contributing to useosm

Welcome

First off, I'm really glad you're reading this, because we need volunteer developers and writers to help improve useosm!

We welcome and encourage contributors of all skill levels and we are committed to making sure your participation in useosm project is inclusive, enjoyable, and rewarding. If you have never contributed to an open-source project before, we are a good place to start and will make sure you are supported every step of the way.

If you have any questions, please ask!

Ways to Contribute

There are many ways to contribute to the useosm Project:

  1. Code: Improve the codebase using Python, JS, Astro, or React.
  2. Content: Add or update Resources and Use Case information (Markdown).
  3. Translation: Translate articles and documentation into local languages.
  4. Triage: Report bugs and suggest improvements.

Report bugs and suggest improvements

The issue queue is the best way to get started. There are issue templates for BUGs and FEATURES that you can use, or you can create your own.

Code Contributions

Create pull requests (PRs) for changes that you think are needed. We ask that you follow our coding contribution guidelines.

Skills with the following would be beneficial:

  • Python
  • Javascript
  • Astro
  • React
  • Content Writing (Markdown)

Our latest task board can be found here.

Content Contributions: Resources & Use Cases

We actively encourage contributions to the documentation and informational content. Much of the site content is powered by Markdown files.

You can contribute by:

  • Adding Resources: improving our list of resources, tools, and reference materials.
  • Documenting Use Cases: writing about real-world scenarios, case studies, or examples of how osm is utilized.

To contribute content:

  1. Locate the relevant Markdown file in the repository (usually found in the content/ or config/ directory).
  2. Edit the file to add your new Resource or Use Case.
  3. Submit a Pull Request with your text changes.

Translating

We want useosm to be accessible to everyone. You can help by reviewing or submitting.

We specifically need help translating:

  • Articles: Blog posts and news updates.
  • Resources Information: Descriptions of tools and guides.
  • Use Case Information: Explanations of how the tool is used in different contexts.

Testing

(Testing guidelines to be added. Please ensure your code runs locally before submitting.)

Thank you!

Thank you very much in advance for your contributions! Please ensure you refer to our Code of Conduct when you contribute.

If you've read the guidelines, but you are still not sure how to contribute on Github, please reach out to us via Email and we will be happy to help!