Skip to content

Latest commit

 

History

History
69 lines (57 loc) · 3.95 KB

CONTRIBUTING.rst

File metadata and controls

69 lines (57 loc) · 3.95 KB

Contributing to Bast

First of all, Thanks for deciding to contribute to Bast. With People like you, Open Source would forever be Open 🙇 😃 🎉

The following is a set of guidelines for contributing to Bast. Feel free to propose changes to this document in a pull request

How Can I Contribute?

You can contribute to the project through the following ways

Reporting Bugs

When reporting bugs, there are a few steps to take
  • Make sure someone else has not made an issue with the same bug. If someone else has and the issue is still open, add a comment to the issue stating your own issues with the relevant traceback errors
  • If the issue has not been reported, create an issue on Github and make sure you follow our ISSUE TEMPLATE as it would make life easier for both you, the maintainers and the community at large
  • Please, use a clear and descriptive title for the issue to identify the problem
  • Describe the exact steps to take to reproduce the exact same problem both the how and why in as many details as possible.
  • Explain which behaviour you expected to see instead and why after following the steps
  • Include the traceback error as a code snippet or as an included screenshot in order to better trace the errors
  • Include the code block which throws the error as a code snippet
  • Include details about your configuration environment (what OS, what python version e.t.c)

Suggesting New Features and enhancement

This section guides you through submitting an enhancement suggestion for Bast, 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 🔎.

When you are creating a feature or enhancement suggestion, please include as many details as possible. Fill in the template, including what the feature/enhancement would achieve.

Before Submitting a request for an enhancement
  • Check to make sure that there is no feature similar to that which you have. Go through the classes, functions and methods.

Please note that New features and Enhancements not on the RoadMap are tracked as Github Issues.

To submit a good suggestion
  • 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. Include copy/pasteable snippets which you use in those examples
  • Describe the current behavior and explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs which help you demonstrate the steps (if available)
  • Explain why this enhancement would be useful to most Bast users.
  • List some other frameworks where this enhancement exists if applicable.

Git 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
  • Consider starting the commit message with an applicable emoji:
    • 🎨 when improving the format/structure of the code
    • 🐎 when improving performance
    • 🚱 when plugging memory leaks
    • 📝 when writing docs
    • 🐧 when fixing something on Linux
    • 🍎 when fixing something on macOS
    • 🏁 when fixing something on Windows
    • 🐛 when fixing a bug
    • 🔥 when removing code or files
    • 💚 when fixing the CI build
    • ✅ when adding tests
    • 🔒 when dealing with security
    • ⬆️ when upgrading dependencies
    • ⬇️ when downgrading dependencies