Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
121 lines (84 loc) · 5.88 KB

CONTRIBUTING.md

File metadata and controls

121 lines (84 loc) · 5.88 KB
Raw

Contributing to Uni-Table

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the Table of Contents for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Table of Contents

Code of Conduct

This project and everyone participating in it is governed by the Uni-Table Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to developers.unify@gmail.com.

I Have a Question

If you want to ask a question, we assume that you have read the available Documentation.

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

  • Open an Issue.
  • Provide as much context as you can about what you're running into.
  • Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

I Want To Contribute

Project Setup

This project is a monorepo containing the uni-table library and a demo application. To get started:

  1. Install Dependencies:

    npm install

  2. Build the Library: Before serving the demo app, you must build the library so that it can be consumed.

    ng build uni-table

  3. Run the Demo Application: Start the local development server. This will serve the uni-table-demo project.

    ng serve

    Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Reporting Bugs

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to developers.unify@gmail.com.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open an Issue. (Since we can't be sure the bug exists in your environment or others, please provide a reproduction steps or repository).
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Uni-Table, including completely new features and minor improvements to existing functionality. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.

How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as GitHub issues.

  • Use a clear and descriptive title for the issue to identify the suggestion.
  • Provide a step-by-step description of the suggested enhancement in as many details as possible.
  • Describe the current behavior and explain which behavior you expected to see instead and why. At this point you can also tell which alternatives you do not like.
  • You may want to include screenshots and animated GIFs which help you demonstrate the steps or point out the part which the suggestion is related to.
  • Explain why this enhancement would be useful to most Uni-Table users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

Your First Code Contribution

  1. Fork the project.
  2. Clone your fork.
  3. Create a new branch (git checkout -b feature/amazing-feature).
  4. Make your changes.
  5. Commit your changes (git commit -m 'Add some amazing feature').
  6. Push to the branch (git push origin feature/amazing-feature).
  7. Open a Pull Request.

Improving The Documentation

Documentation improvements are always welcome! You can edit the markdown files directly and submit a PR.

Styleguides

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line