Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.73 KB

CONTRIBUTING.md

File metadata and controls

45 lines (27 loc) · 2.73 KB
Raw

Introduction

You are here to help on companies-on-blm? Awesome, feel welcome and read the following sections in order to know how to ask questions and how to work on something. All members of our community are expected to follow our Code of Conduct. Please make sure you are welcoming and friendly in all of our spaces.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.

There are many ways to contribute, from writing blog posts, improving the documentation, submitting bug reports and feature requests or writing code which can be incorporated into the project itself.

Ground rules

Code and documentation contributions are welcome via GitHub pull requests.

For all contributions, please respect the following guidelines:

  • Each pull request should implement ONE feature or bugfix. If you want to add or fix more than one thing, submit more than one pull request.
  • Do not commit changes to files that are irrelevant to your feature or bugfix (e.g., .gitignore).
  • Be willing to accept criticism and work on improving your code.
  • Be aware that the pull request review process is not immediate, and is generally proportional to the size of the pull request.
  • Be welcoming to newcomers and encourage diverse new contributors from all backgrounds.

Reporting bugs

To report bugs, fill an issue using the bug template.

Suggesting features

To suggest features, fill an issue using the enhancement template.

Making your first contribution

If you are new to the project and looking for a way to get involved, try picking up an issue with a "beginner-friendly" label. Hints about what needs to be done are usually provided.

Working on your first pull-request on GitHub? Check out resources from Make A Pull Request or First Timers Only.

Getting started

  1. Create your own fork of the code
  2. Do the changes in your fork
  3. If you like the change and think the project could use it, submit a pull request. Pull request should follow the provided PR template.

The core team looks at Pull Requests on a regular basis to accept them or request changes.

Credit

This contributing guide is heavily inspired from nayafia's template.