Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.29 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 2.29 KB

Contributing to transeptor

Why Contribute

Transeptor is an open source project that welcomes contributions from anyone in the community. By contributing to this project, you can:

  • Help improve the quality of the software for everyone who uses it.
  • Learn new skills and gain experience working on a real-world project.
  • Collaborate with other developers from around the world.
  • Build your portfolio and demonstrate your skills to potential employers.
  • Gain experience working with Ethereum and blockchain technology.

We appreciate any contributions, big or small, and thank you for taking the time to help make our project better.

How to Contribute

  1. Clone the repo to your local machine. git clone https://github.com/Transeptor/transeptor-bundler.git
  2. Install dependencies with npm install.
  3. Create a new branch for your changes with git checkout -b my-branch-name.
  4. Make your changes and commit them with descriptive commit messages.
  5. Push your branch to your forked repository with git push origin my-branch-name.
  6. Create a pull request to the main branch of the original repository.

Code Style

We use ESLint to enforce code style in our project. Please make sure your changes conform to our style guidelines by running npm run lint and fixing any errors or warnings.

If you need more information, leave a comment or join the Telegram channel.

Testing

We use Jest for unit testing in our project. Please make sure your changes include appropriate tests and pass all existing tests by running npm test.

Pull Request Guidelines

When you submit a pull request, please make sure to include a description of your changes and any related issues or pull requests. We also ask that you:

  • Keep your pull requests focused on a single issue or feature.
  • Write clear and concise commit messages.
  • Make sure your changes are well-tested and pass all existing tests.
  • Be open to feedback and willing to make changes to your code if necessary.
  • Follow our code style guidelines and formatting conventions.
  • Squash multiple commits into a single commit with a descriptive commit message, if necessary.

Thank You

Thank you for considering contributing to Transeptor! Your contributions help make our project better, and we appreciate your time and effort.