Skip to content

Latest commit

 

History

History
91 lines (62 loc) · 4.11 KB

CONTRIBUTING.md

File metadata and controls

91 lines (62 loc) · 4.11 KB

Contributing to Algorand Node Running

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. 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
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

I Have a Question

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

As this is a guide repository please use Github Discussions to ask questions.

I Want To Contribute

Legal Notice

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.

Reporting Bugs

Before Submitting a Bug Report

Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are reporting an issue with our guides, not with the node software itself.

How Do I Submit a Good Bug Report?

We use GitHub issues to track errors in our guides. If you run into an issue with the project:

  • Open an Issue.
  • Explain which part of a guide is obsolete or does not seem to be correct.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Algorand Node Running. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

Before Submitting an Enhancement

  • 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.
  • Explain why this enhancement would be useful to most Algorand Node Running users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Guide Contribution

TDB

Improving The Documentation

Styleguides

Commit Messages

TDB

Join The Project Team

Please contact [email protected] if you want to become the project team member and start contributing directly or help with issue maintenance.

Attribution

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