Skip to content

Latest commit

 

History

History
61 lines (35 loc) · 2.3 KB

CONTRIBUTING.md

File metadata and controls

61 lines (35 loc) · 2.3 KB

Contributing to Boost My Project Network

First off, thank you for considering contributing to Boost My Project Network! It's people like you that make Boost My Project Network such a great community.

Code of Conduct

We have a Code of Conduct in place that we expect all contributors to adhere to. Please read the full text to understand what actions will and will not be tolerated.

How Can I Contribute?

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues.

  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  1. Open a new issue with a clear list of what you want to add. Include as many details as possible.

  2. Remember, the more effort you put into your proposal, the more effort we can put into evaluating it.

Your First Code Contribution

  1. Fork the repository and create your branch from main.

  2. Make your changes.

  3. Make sure your code lints and screen shot captured in required devices.

  4. Issue that pull request!

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 fewer
  • Reference issues and pull requests liberally after the first line

JavaScript Styleguide

All JavaScript must adhere to JavaScript Standard Style.

Documentation Styleguide

Additional Notes

Issue and Pull Request Labels

This section lists the labels we use to help us track and manage issues and pull requests.

Label Name Description
bug Confirmed issues or issues that are very likely to be bugs.
feature-request Feature requests.
good-first-issue Good for newcomers.
help-wanted Extra attention is needed.