Contributing

Thank you for your interest in contributing to Revogrid! 🎉

Why Contribute?

Contributing to Revogrid not only offers developers the chance to enhance their skills and collaborate on cutting-edge data grid technology but also presents a unique opportunity for professional growth and financial gain. By participating in the development of Revogrid, contributors can directly influence a tool used by companies worldwide, adding significant value to their professional portfolio. Moreover, standout contributors may have the opportunity to join our team full-time or benefit from paid project work, tapping into new career opportunities and monetary rewards. Contributing to Revogrid is more than just coding—it's a chance to join a community that rewards your expertise and dedication with tangible benefits.

Contributing Etiquette

Please see our Contributor Code of Conduct for information on our rules of conduct.

Reporting a Bug

• It is required that you clearly describe the steps necessary to reproduce the issue you are encountering. Diagnosing issues without clear reproduction steps is extremely time-consuming and not sustainable.

• The issue list of this repository is exclusively for bug reports and feature requests. Non-conforming issues will be closed immediately.

• Issues with no clear steps to reproduce will not be triaged.

• If you think you have found a bug, please check if it has already been reported. You can search through existing issues and include closed ones as it may have been resolved.

  • If a bug report already exists, please upvote it using the 👍 reaction on the GitHub Issue summary to avoid "+1" comments.

• Next, create a new issue that thoroughly explains the problem.

  • Please fill out the issue form completely before submitting.
  • Please only include one bug per issue.

Requesting a Feature

• Before requesting a feature, check if it has already been proposed.

  • If a feature request already exists, please support it using the 👍 reaction on the GitHub Issue summary.

• Next, create a new feature request that thoroughly explains the desired feature.

  • Please fill out the feature request form completely before submitting.
  • Please only include one feature request per report.

Creating a Pull Request

• We appreciate your willingness to contribute! Before submitting a pull request, please create an issue discussing the bug or feature request and indicate that you plan to work on it. If an issue already exists, please comment on that issue stating your intention to submit a pull request. This helps us track pull requests and ensure there is no duplicated effort.

Setup

1. Fork the repo.
2. Clone your fork.
3. Create a branch for your changes.
4. Run npm install to install dependencies.
5. Make your changes.

Making Sure Your Changes Are Ready

1. Add unit tests for any new or changed functionality. Look at existing tests for guidance on how to write tests.
2. Run npm run build to ensure your code compiles correctly.
3. Run npm test to make sure all tests pass.

Submitting Your Changes

After you've made sure all tests pass:

1. Push your changes to your fork.
2. Submit a pull request to the Revogrid repository.
3. Provide a detailed description of your changes and reference the issue number.

Commit Message Format

We follow the Angular Commit Message Format:

• Type: feat, fix, docs, style, refactor, perf, test, chore, revert.
• Scope: The scope could be anything specifying the place of the commit change.
• Subject: Brief description of the change.

License

By contributing to Revogrid, you agree that your contributions will be licensed under its MIT License.