Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 3.95 KB

CONTRIBUTING.md

File metadata and controls

76 lines (50 loc) · 3.95 KB

Contributing to NepaliKit

🎉 First off, thanks for taking the time to contribute! 🎉

The following is a set of guidelines for contributing to NepaliKit. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Table of Contents

  1. Code of Conduct
  2. How Can I Contribute?
  3. Style Guides
  4. Additional Resources

Code of Conduct

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

How Can I Contribute?

Reporting Bugs

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

  • 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.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for NepaliKit, including completely new features and minor improvements to existing functionality.

  • Ensure the enhancement was not already suggested by searching on GitHub under Issues.
  • If you find an open issue addressing your suggestion, please add your thoughts there.
  • If you're unable to find an open issue addressing the suggestion, open a new one.

Your First Code Contribution

Unsure where to begin contributing to NepaliKit? You can start by looking through these good-first-issue and help-wanted issues:

Pull Requests

  • Ensure any install or build dependencies are removed before the end of the layer when doing a build.
  • Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
  • Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent. The versioning scheme we use is SemVer.
  • You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.

Style Guides

Python Style Guide

  • Follow PEP 8 - the Python style guide.
  • Use 4 spaces for indentation.
  • Use docstrings to describe the purpose of each class, method, and function.

Commit Messages

  • 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.

Additional Resources