Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 3.05 KB

CONTRIBUTING.MD

File metadata and controls

40 lines (26 loc) · 3.05 KB
Raw

Contributing to m3ters.js: Building Clarity Together

We welcome contributions from passionate developers like you to help evolve m3ters.js and make it an even more powerful tool for interacting with the M3tering Protocol. We encourage contributions of all types, whether it's fixing bugs, adding new features, improving documentation, or simply suggesting ideas.

Before you dive in, please take a moment to familiarize yourself with these guidelines:

Getting Started:

  • Fork the repository: Head over to the m3ters.js GitHub repository and click the "Fork" button. This creates a copy of the codebase in your own account, allowing you to make changes and submit them for review.
  • Set up your development environment: Make sure you have Node.js (version 19 or above) and npm installed on your system. Then, clone your forked repository locally and install the dependencies:
git clone https://github.com/your-username/m3ters.js
cd m3ters.js
npm install
  • Branching strategy: We use feature branches for all bug fixes and new features. Please create a new branch for your contribution based on the main branch, and name it descriptively using the format feature/your-contribution-name.

Making Changes:

  • Follow our coding style: We use Prettier and ESLint to maintain consistent code formatting and quality. Please run npm run lint before committing your changes to ensure they adhere to our conventions.
  • Write clear and concise commit messages: Your commit messages should briefly explain what you changed and why. Use a subject line that summarizes the change followed by a body that provides more details.
  • Unit tests: If you're adding new functionality, please write unit tests to ensure it works as expected. We use Jest for our unit testing framework.

Submitting your Contribution:

  • Push your changes to your forked repository: Once you're happy with your changes, push them to your feature branch on your forked repository.
  • Create a pull request: Head over to your forked repository on GitHub and create a pull request from your feature branch to the main branch of the upstream repository. Be sure to provide a clear and concise description of your changes in the pull request description.
  • Engage in the review process: We encourage discussion and feedback on pull requests. Be patient and responsive to any comments or questions from the maintainers.

Additional points to remember:

  • Stay respectful and professional: We strive to maintain a welcoming and inclusive community. Please treat everyone with respect and avoid any discriminatory or offensive language.
  • Be mindful of scope: Try to keep your pull requests focused on a single issue or feature. Larger changes should be broken down into smaller, more manageable pieces.
  • Don't hesitate to ask for help: If you encounter any problems or have any questions, feel free to reach out to the maintainers for assistance. We're happy to help!

We appreciate your contributions to m3ters.js! Together, we can make it even better.

Happy coding!