Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.14 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 3.14 KB

Contributing to gitflow-genius-action

First off, thank you for considering contributing to gitflow-genius-action! 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 be deeply appreciated.

Code of Conduct

This project and everyone participating in it is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [project email].

How Can I Contribute?

Reporting Bugs

This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.

Before Submitting A Bug Report

  • Ensure the bug was not already reported by searching on GitHub under Issues.
  • If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

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

Before Submitting An Enhancement Suggestion

  • Check if the enhancement has already been suggested under Issues.
  • If it has not, create a new issue, clearly outline the improvement, and provide a detailed use case.

Your First Code Contribution

Unsure where to begin contributing? You can start by looking through beginner and help-wanted issues.

Pull Requests

Here are the steps to make your contributions:

  1. Fork the repo and create your branch from develop.
  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 your pull request!

High-Quality Code Standards

  • Write clear, maintainable code and include comments where necessary.
  • Follow the conventional commits guidelines.
  • Ensure your feature branching from the development branch.
  • Make sure your code is accompanied by a good level of unit test coverage for high code quality assurance.

Documentation Contributions

We use JSDoc blocks for code documentation. Ensure your contributions are well documented in the JSDoc format.

Communication and Questions

If you have any questions, please create an issue in the repository, and it will be labeled with 'question' by the codeowners.

More on Environment Setup

For setting up your environment, refer to the README, or use the provided devcontainer setup that includes all the required tooling.

Recognition

Contributors who have significantly contributed to the project will be recognized in the project documentation and on a contributors' list.