First off, thank you for considering contributing to LabyrinthFS! It's people like you that make the open-source community such a fantastic place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.
This project and everyone participating in it are governed by the LabyrinthFS Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable.
There are many ways you can contribute to LabyrinthFS, from writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code which can be incorporated into LabyrinthFS itself.
This section guides you through submitting a bug report for LabyrinthFS. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before Submitting A Bug Report
- Check the debugging guide for tips on debugging your issue.
- Ensure the bug was not already reported by searching on GitHub under Issues.
How Do I Submit A Good Bug Report?
Bugs are tracked as GitHub issues. Explain the problem and include additional details to help maintainers reproduce the problem:
- Use a clear and descriptive title for the issue to identify the problem.
- Describe the exact steps which reproduce the problem in as many details as possible.
- Provide specific examples to demonstrate the steps. Include links to files or GitHub projects, or copy/pasteable snippets, which you use in those examples.
This section guides you through submitting an enhancement suggestion for LabyrinthFS, including completely new features and minor improvements to existing functionality.
Before Submitting An Enhancement Suggestion
- Check if the enhancement has already been suggested.
- Determine which repository the enhancement should be suggested in.
How Do I Submit A Good Enhancement Suggestion?
Enhancement suggestions are tracked as GitHub issues. Provide the following information:
- 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.
- Provide specific examples to demonstrate the steps.
The process described here has several goals:
- Maintain LabyrinthFS's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible LabyrinthFS
Follow these steps to have your contribution considered by the maintainers:
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing
What if the status checks are failing?
If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-evaluate the status check.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
All JavaScript must adhere to JavaScript Standard Style.
- Include screenshots and animated GIFs in your pull request whenever possible.
- Follow the JavaScript styleguide.
- Document new code based on the JSDoc guidelines.
- End all files with a newline.
This section lists the labels we use to help us track and manage issues and pull requests.
Guidelines for issue labels:
bug- Issues that are bugs.enhancement- Issues that are feature requests.documentation- Issues related to documentation.good first issue- Good issues for first-time contributors.