Skip to content

Latest commit

 

History

History
55 lines (44 loc) · 2.51 KB

CONTRIBUTING.md

File metadata and controls

55 lines (44 loc) · 2.51 KB
Raw

Code of Conduct

This project and everyone participating in it is governed by the Nova Spektr Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to pavel@novawallet.io.

How to Contribute

Reporting Bugs

Before opening a new issue, please search the existing issues to make sure that the bug has not already been reported. If it has not, please open a new issue and include the following information:

  • A clear and descriptive title
  • Steps to reproduce the issue
  • Expected behavior
  • Actual behavior
  • Nova Spektr version
  • Nova Spektr logs

Suggesting Enhancements

If you have a suggestion for how to improve the project, please open a new issue and include the following information:

  • A clear and descriptive title
  • An explanation of the enhancement and why it would be useful
  • Any relevant code samples or screenshots

Contributing Code

To contribute code to the project, please follow these steps:

  1. Fork the repository
  2. Clone your forked repository
  3. Install the development dependencies with pnpm install
  4. Make your changes on a new branch, preferably with a name that describes the changes you are making
  5. Run the tests with pnpm test to make sure that your changes did not introduce any regressions
  6. Test your changes. Use pnpm start for running the application
  7. Push your changes to your forked repository
  8. Open a pull request against the dev branch of the Nova Spektr repository
  9. Wait for feedback from the maintainers

When contributing code, please keep the following guidelines in mind:

  • Follow the existing code style and conventions
  • Write clear and concise commit messages
  • Write tests for any new functionality that you add
  • Keep the scope of your changes as small as possible

Reviewing Code

If you are reviewing code that has been submitted by someone else, please follow these guidelines:

  • Be respectful and constructive in your feedback
  • Focus on the code, not the person who wrote it
  • Keep the review focused on the changes that were made, not on the author's original intentions
  • Remember that the goal is to improve the project, not to prove that you are right

License

By contributing to the Nova Spektr project, you agree that your contributions will be licensed under the Apache 2.0 License.