Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (40 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

57 lines (40 loc) · 2.24 KB

Contributing to JavaScript Note

Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to setemiojo@gmail.com.

How to Contribute

Reporting Bugs

If you find a bug, please open an issue here with the following details:

  • A short description of the bug.
  • Steps to reproduce the bug.
  • Expected behavior.
  • Actual behavior.

Suggesting Enhancements

If you have an idea for an enhancement, please open an issue here with the following details:

  • A short description of the enhancement.
  • The motivation behind the enhancement.
  • How it will benefit the project.

Submitting Pull Requests

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/your-feature-name).
  3. Make your changes.
  4. Commit your changes (git commit -m 'Add some feature').
  5. Push to the branch (git push origin feature/your-feature-name).
  6. Open a pull request here.

Coding Standards

  • Follow the existing code style.
  • Write clear, concise commit messages.
  • Include comments where necessary.

Follow this Guide Religiously

  • Create an issue for the section of the note you will be working on.
  • The title should be the section of the note you will be working on. (One of the sections in the pages directory)
  • The body of the issues should match the content listed in the section.
  • Follow mdn, javascript.info or any informational guide.
  • To create the content, you will need to know markdown and sli.dev.
  • Ensure you test changes locally and after making the pr test using the netlify generated link.
  • Assign the right label to the issue and link the issue to the pr.

Previous Notes