Skip to content

Latest commit

 

History

History
103 lines (64 loc) · 5.06 KB

CONTRIBUTING.md

File metadata and controls

103 lines (64 loc) · 5.06 KB
Raw

CASE Contribution

Thanks you very much for contributing and Happy Hacktoberfest ! 🎉 🧙‍♂️

CASE is an Open-Source CRUD app generator that helps developers to build CRUD web applications in 15 minutes by focusing only on the data.

CASE is made with love, lo-fi and headaches using Angular, Nest.js & TypeORM.

Table Of Contents

Pre-requisites

CASE is made with Angular, the angular/cli is a pre-requisite.

npm install -g @angular/cli

You may also meet TypeORM concept's like entities, relations or repositories. You can familiarize yourself with their docs here.

Also CASE use the concepts of guards, module and controller from Nest.js. You can have a better understanding of those concepts by checking their docs here.

You don't need to be an expert in those dependencies to contribute - your great ideas, logic, good will & common sense are always welcome to the project ! 🧠🌈

Code contributions

If you are looking for an easy way to help, start by the issues labelled good first issue or documentation ! 💪

Serve CASE in Contribution mode

Open a first terminal :

# From root of the repo.
cd packages/case/client
npm install
ng serve --configuration=contribution

The client is now running on https://localhost:4200 ! 🌸

Open a second terminal simultaneously :

# From root of the repo.
cd packages/case/server
npm install
npm run start:dev

# You have to generate users credentials by seeding data to be able to auth with.
# Seed in dev mode.
npm run seed:dev

The server is now running on contributor mode ! 🌼

⚠️ Times to times you may need to restart your server to see the modifications you brings to the client.

💡 To simulate the app root folder of a new CASE repo, you can use the folder packages/case/server/src/_contribution-root.

Pull Requests

The process described here has several goals:

  • Maintain our quality
  • Fix problems that are important to users
  • Engage the community in working toward the best possible version of CASE
  • Enable a sustainable system for our maintainers to review contributions

Please follow these steps to have your contribution considered by our maintainers:

  1. Follow all instructions in the template
  2. After you submit your pull request, verify that all status checks are passing
    What if the status checks are failing ?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. A maintainer will re-run the status check for you. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

🧙‍♂️ During Hacktoberfest don't forget to add hacktoberfest label to your PR. If it's accepted we will merge it with the hacktoberfest-accepted label. If we judge it is, we will not hesitate to labelled your PR as spammy which can make you disqualified of the Hacktoberfest. 😱

Reporting Bugs

When you are creating a bug report, please include as many details as possible.

Fill out the required template, the information it asks for helps us resolve issues faster.

💡 If you find a Closed issue that seems to be the same bug that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

Suggesting Enhancements

When you are creating an enhancement suggestion, please include as many details as possible.

Start a new discussion by following the template, including the steps that you imagine you would take if the feature you're requesting existed.

Code of Conduct

CASE and everyone contributing in it is governed by the CASE Code of Conduct. By contributing, you are expected to uphold this code. Please report unacceptable behavior to [email protected].