Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 1.58 KB
Raw

Contributing to error-ease

Thank you for considering contributing to error-ease! Let's simplify javascript and typescript ecosystem together!👨‍💻

How to Contribute

  1. Fork the Repository: Fork the repository to your GitHub account and clone it to your local machine.

  2. Install Dependencies: Run npm install to install the necessary dependencies.

  3. Make Changes: Implement your changes or add new features. Ensure that your code follows the project's coding standards.

  4. Test Your Changes: Run the existing tests or add new tests to verify that your changes work as expected.

  5. Submit a Pull Request: After finalizing your modifications, initiate a pull request towards the primary repository. Clearly articulate the intent behind your pull request and outline any significant alterations you've made.

Code Style Guidelines

Kindly observe the code style principles outlined below:

  • Maintain a uniform indentation, preferably opting for either 2 or 4 spaces.
  • Adhere to the existing naming conventions in place.
  • Strive to keep your code succinct and easily readable.

Reporting Issues

If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository. Clearly describe the problem or enhancement, including any relevant details.

License

When you contribute to error-ease, you are acknowledging that your contributions will be licensed under the MIT License. Please consult the license documentation for further details.LICENSE file for more details.