Contributing to Fluxnet Open Source Code Committee Resource Guide

Contributing to Fluxnet Open Source Code Committee Resource Guide#

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

And if you like the project, but just don’t have time to contribute, that’s fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project

  • Tweet about it

  • Refer this project in your project’s readme

  • Mention the project at local meetups and tell your friends/colleagues

Code of Conduct#

This project and everyone participating in it is governed by the Fluxnet Open Source Code Committee Resource Guide Code of Conduct.

I Have a Question#

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. If you don’t find an existing issue and still need clarification, you can write your question in a new issue.

  • Open an Issue.

  • Provide as much context as to what you are trying to achieve or what new information you are looking for.

I Want To Contribute#

When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.

Updating the Website#

The website (outside of tutorials) is built in Markdown, if you want to update the website, you can do so by editing the markdown files in the docs folder. If you want to add a new page, you can do so by creating a new markdown file in the docs folder. You can edit the website directly on GitHub by clicking the pencil icon on the file you want to edit, or you can clone the repository and edit the files locally. In addition, on the website itself there is a button to edit the page on GitHub, just look for the GitHub logo, then click on “Suggest Edit”.

After you have made your changes, you can submit a pull request (see https://www.atlassian.com/git/tutorials/making-a-pull-request or https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) to the main branch.

Suggesting Enhancements#

This section guides you through submitting an enhancement suggestion for Fluxnet Open Source Code Committee Resource Guide, including completely new documentation or tutorials and minor improvements to existing documentation and tutorials. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement#

  • Read the documentation carefully and find out if the documentation or tutorial is already covered.

  • Perform a search to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.

  • Find out whether your idea fits with the scope and aims of the project. It’s up to you to make a strong case to convince the project’s developers of the merits of this feature.

How Do I Submit a Good Enhancement Suggestion?#

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.

  • Provide a step-by-step description of the suggested enhancement in as many details as possible.

  • Explain why this enhancement would be useful to most Fluxnet Open Source Code Committee Resource Guide users.

Reporting a Bug#

Before Submitting a Bug Report#

Bugs can happen in our tutorials or even code snippets in the documentation. if you find a bug, please report it. A good bug report shouldn’t leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.

  • Determine if your bug is really a bug and not an error on your side e.g. using incompatible environment components/versions (make sure that you have read the documentation).

  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the Issues.

  • Collect information about the bug:

  • Stack trace (Traceback)

  • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)

  • Version of the interpreter, compiler, runtime environment, package manager, depending on what seems relevant.

  • Possibly your input and the output

  • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?#

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue.

  • Explain the behavior you would expect and the actual behavior.

  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code.

  • For good bug reports you should isolate the problem and create a reduced test case. This makes it easier to reproduce and fix the bug.

    • A minimally reproducible example is a piece of code that demonstrates the problem you are reporting. This makes it easier to understand the problem and to find a solution.

  • Provide the information you collected in the previous section.

Join The Project Team#

If you want to get involved you can fill out this form or email missik.2@osu.edu.

Attribution#

This guide is based on the contributing-gen. Make your own!

Contents