Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (39 loc) · 2.71 KB

CONTRIBUTING.md

File metadata and controls

68 lines (39 loc) · 2.71 KB

Contributing to MaplePHP

First off, thank you for considering contributing to MaplePHP. It's people like you that make MaplePHP such a great tool.

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

Please note we have a code of conduct, please follow it in all your interactions with the project.

Code of Conduct

[Your Project Name] adheres to a Code of Conduct adapted from the Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. By participating, you are expected to uphold this code.

Getting Started

Before you begin:

  • Have you read the code of conduct?
  • Check out the existing issues to see if someone else has already submitted a similar bug report or feature request.
  • New to GitHub? Take a look at the GitHub Help to get started.

How to Contribute

If you're ready to contribute, here's how you can do it:

Reporting Bugs

Bugs are tracked as GitHub issues. Create an issue on our repository and label it as "bug". Explain the bug in detail, add more context with images or links if necessary.

Suggesting Enhancements

Enhancements are also tracked as GitHub issues. Want a new feature or consider an existing one for modification? Submit an issue labeled as "enhancement". Describe your idea in detail, its benefits, and possible drawbacks.

Pull Requests

  1. Fork the repository.
  2. Create your feature branch (git checkout -b feature/AmazingFeature).
  3. Commit your changes (git commit -am 'Add some AmazingFeature').
  4. Push to the branch (git push origin feature/AmazingFeature).
  5. Open a Pull Request.

Pull Request Guidelines

  • 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, useful file locations, and container parameters.

Styleguides

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.

Coding Standards

  • Ensure all tests pass before submitting a pull request.

Community

  • Join our mailing list or Slack channel to get in touch with the community and discuss current issues and possible improvements.

Acknowledgments

  • State if you are open to receiving contributions for specific areas or if there are any restrictions on contributions.

Thank you for contributing to MaplePHP!