Skip to content

Latest commit

 

History

History
101 lines (68 loc) · 4.16 KB

CONTRIBUTING.md

File metadata and controls

101 lines (68 loc) · 4.16 KB
Raw

Contributing

Welcome to HAMi!

Before you get started

Code of Conduct

Please make sure to read and observe our Code of Conduct.

Community Expectations

HAMi is a community project driven by its community which strives to promote a healthy, friendly and productive environment.

Getting started

  • Fork the repository on GitHub
  • Make your changes in your forked repository
  • Submit a Pull Request (PR)

Your First Contribution

We will help you contribute in different areas such as filing issues, developing features, fixing critical bugs and getting your work reviewed and merged.

If you have questions about the development process, feel free to file an issue.

Find something to work on

We are always in need of help, whether it's fixing documentation, reporting bugs, or writing code. Look for places where best coding practices aren't followed, code refactoring is needed, or tests are missing. Here's how you can get started.

Find a good first topic

There are multiple repositories within the HAMi organization. Each repository has beginner-friendly issues marked as "good first issues". For example, Project-HAMi/HAMi has help wanted and good first issue labels for issues that should not require deep knowledge of the system. We can help new contributors who wish to work on such issues.

Another good way to contribute is to find documentation improvements, such as fixing missing or broken links. Please see Contributing below for the workflow.

Work on an issue

When you are willing to take on an issue, simply reply to the issue and a maintainer will assign it to you.

File an Issue

While we encourage everyone to contribute code, we also appreciate when someone reports an issue. Issues should be filed under the appropriate HAMi sub-repository.

Example: A HAMi issue should be opened in Project-HAMi/HAMi.

Please follow the provided submission guidelines when opening an issue.

Contributor Workflow

Please never hesitate to ask questions or submit a pull request.

This is a rough outline of what a contributor's workflow looks like:

  • Create a topic branch from where you want to base the contribution (usually master)
  • Make commits of logical units
  • Push changes in your topic branch to your personal fork of the repository
  • Submit a pull request to Project-HAMi/HAMi

Creating Pull Requests

Pull requests are often called simply "PRs". HAMi generally follows the standard GitHub pull request process. To submit a proposed change, please develop the code/fix and add new test cases. Before submitting a pull request, run these local verifications to predict whether continuous integration will pass or fail:

  • Run and pass make verify

Code Review

To make it easier for your PR to receive reviews, consider that reviewers will need you to:

  • Follow good coding guidelines
  • Write good commit messages
  • Break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue