Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 3.09 KB

CONTRIBUTING.md

File metadata and controls

50 lines (29 loc) · 3.09 KB
Raw

Contributing to Graphweaver

Thank you for considering contributing to Graphweaver! We appreciate your interest in making this project better.

How to Contribute

We welcome all kinds of contributions, whether it's reporting a bug, submitting a feature request, improving documentation, or proposing code changes. To get started, follow these steps:

  1. Fork the repository on GitHub.
  2. Clone the forked repository to your local machine.
  3. Create a new branch from the main branch for your changes. Give your branch a descriptive and meaningful name.
  4. Make your changes and ensure they adhere to the project's coding guidelines.
  5. Test your changes to make sure they work as intended.
  6. Commit your changes with a clear and concise commit message.
  7. Push your changes to your forked repository.
  8. Submit a pull request to the main repository and provide a detailed explanation of your changes.

Bug Reports and Feature Requests

If you encounter a bug or have an idea for a new feature, please open an issue with the relevant information. Be sure to include steps to reproduce the bug or a clear description of the proposed feature.

Code Style

Please follow the project's coding style and conventions when submitting code changes. If you are unsure about any aspect of the coding guidelines, feel free to ask in your pull request or as a comment in the related issue.

Testing

Before submitting a pull request, ensure that all existing tests pass and add new tests where relevant to cover your changes within the end to end test package. Make sure to run the test suite locally to confirm that everything works as expected.

Use of packages containing native modules

We are working to keep Graphweaver free of dependencies that contain native modules. This increases deployment complexity as native code cannot be bundled, which increases complexity in the deployment process. We have included a standalone test (in the end-to-end test project) as well as a check in Github Actions to help detect if native modules have made their way into Graphweaver project dependencies. Note this restriction only applies to production dependencies - dev dependencies are allowed to contain native modules as they are not included in production builds.

Documentation

Improvements to the project's documentation are always welcome. If you find any parts of the documentation that are unclear or incomplete, please feel free to report the issue and we can work to update it.

Code of Conduct

Please note that this project follows an Open Source Code of Conduct. By participating in this project, you are expected to uphold this code of conduct.

Acknowledgments

If your contribution is significant, we will acknowledge you in the project's README file. Make sure to include your name and GitHub username in your pull request message if you wish to be credited.

Contact

If you have any questions or need further assistance, you can reach out to us via hello@graphweaver.com.

Thank you for your contributions!