Skip to content

Latest commit

 

History

History
95 lines (62 loc) · 4.91 KB

CONTRIBUTING.md

File metadata and controls

95 lines (62 loc) · 4.91 KB
Raw

Contributing to fern-reporter

First off, thank you for considering contributing to fern-reporter! It's people like you that make the open source community such a great place to learn, inspire, and create. Any contributions you make are greatly appreciated.

Code of Conduct

While we are not a CNCF project, we fully support and endorse its general principles. As an extension, fern-reporter follows their Code of Conduct that we expect project participants to adhere to. Please read the full text so that you can understand what actions will and will not be tolerated.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the issue tracker as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible by filling out the required template. Follow the "How to Report a Bug" guidelines.

How to Report a Bug

  1. Use a clear and descriptive title for the issue to identify the problem.
  2. Describe the exact steps which reproduce the problem in as many details as possible.
  3. Provide specific examples to demonstrate the steps.
  4. Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  5. Explain which behavior you expected to see instead and why.
  6. Include screenshots and animated GIFs if possible.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for fern-reporter, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion.

How to Suggest Enhancements

  1. Use a clear and descriptive title for the issue to identify the suggestion.
  2. Provide a step-by-step description of the suggested enhancement in as many details as possible.
  3. Provide specific examples to demonstrate the steps. Include copy/pasteable snippets which you use in those examples, as Markdown code blocks.
  4. Describe the current behavior and explain which behavior you expected to see instead and why.
  5. Explain why this enhancement would be useful to most fern-reporter users.
  6. List some other projects where this enhancement exists.

Your First Code Contribution

Unsure where to begin contributing to fern-reporter? You can start by looking through 'beginner' and 'help-wanted' issues:

  • Beginner issues - issues which should only require a few lines of code, and a test or two.
  • Help wanted issues - issues which should be a bit more involved than 'beginner' issues.

Pull Requests

The process described here has several goals:

  • Maintain fern-reporter's quality.
  • Fix problems that are important to users.
  • Engage the community in working toward the best possible fern-reporter.

Here are the steps for submitting a pull request:

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. Ensure the test suite passes.
  4. Make sure your code lints.
  5. Issue that pull request!

Pull Request Checklist

  • I have read the contributing guidelines.
  • I have performed a self-review of my own code or materials.
  • I have commented my code or provided relevant documentation, particularly in hard-to-understand areas.
  • I have made corresponding changes to the documentation.
  • I have tested with both the fern client and fern server
  • Any dependent changes have been merged and published in downstream modules.

Pull Requests Process

You will be asked to sign a Developer Certificate of Origin or DCO where you certify that you wrote or otherwise have the right to submit the code. Once the pull request is opened, a fern-reporter maintainer will review your changes. If all is good, your pull request will be merged into the main codebase.

Styleguides

Git Commit Messages

  • Follow conventional commit messages mentioned here
  • 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.

Coding Conventions

  • Write clean, manageable code and follow the coding conventions of the project.
  • Keep it simple and readable.
  • Make sure you follow the go style guide mentioned here

Questions?

Feel free to contact the project maintainers, either through the issue tracker or directly.