Any interest in adding a code of conduct/contributor guide?

zouhir / jarvis

A very intelligent browser based Webpack dashboard

5.44k stars 191 forks source link

Any interest in adding a code of conduct/contributor guide? #79

Closed Pickra closed 6 years ago

Pickra commented 6 years ago

Here's a starting point.

Sunshine168 commented 6 years ago

Add contribute guide in readme will be better?

Pickra commented 6 years ago

Why not both?

zouhir commented 6 years ago

That is a good idea, we NEED to have those asap :)

Pickra commented 6 years ago

Are you good w/the code of conduct starting point @zouhir or do you want something else?

Any specifics for the contributor guide @Sunshine168?

Pickra commented 6 years ago

A few thoughts for contributing

A couple things from Angular

found-a-bug
submitting-a-pull-request-pr: Search GitHub for an open or closed PR that relates to your submission. You don't want to duplicate effort.

Random

Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
Prerequisite: Node >= 6
PRs should come with tests

My preferences

A UI change, something w/no movement, requires a screenshot in your PR
A UX change, something w/movement, requires a video/screencast
- jing is free

Sunshine168 commented 6 years ago

@Pickra

Some thoughts for contributing

Development

Visit the issue tracker to find a list of open issues that need attention. Fork, then clone the repo:

https://github.com/zouhir/jarvis.git

Building

Running the build task will create jarvis's client in bin folder

npm run build
// or
yarn build

Developing

npm run dev
// or
yarn dev

Tesing

(PS: After finishing the test suite )

npm run jest
// or
yarn jest

In general, the contribution workflow looks like this:

Open a new issue in the Issue tracker.
Fork the repo.
Create a new feature branch based off the master branch.
Make sure all tests pass.
Submit a pull request, referencing any issues it addresses.

It will more friendly

And new UI change or feature with idea or screenshot even prototype ,should be discussing in issue.

Pickra commented 6 years ago

Yarn isn't a dep. Why are you including it, do you want to add it @Sunshine168?

Pickra commented 6 years ago

We can hook up tests to run in a pre-push and/or on watch

TimoStaudinger commented 6 years ago

@Pickra Not sure if I misunderstand you, but yarn shouldn't require any special requirements.

It's really just a (mostly) equivalent replacement of npm. It pretty much does the same job, just usually more efficiently and in a deterministic fashion (through lock files).

I can only recommend the switch! :-)

zouhir commented 6 years ago

correct @TimoSta - If users are on yarn instead of npm things should work as usual for them no problems, and totally fine as long as they don't commit their own lockfile to the repo since we already have package-lock :)

Sunshine168 commented 6 years ago

yap, @TimoSta is correct ,yarn just a optional usage for users more efficiently and clearly do the some job as npm . Seem that our gitignore is including the yarn file , so dont worry about they commit their lock file .

Pickra commented 6 years ago

Not opposed to it being in the contributor guide. My bad, apparently I've been yarning wrong this whole time.

Are there any other additions to the contributors guide/code of conduct or are we good w/what's here?

Sunshine168 commented 6 years ago

ah , we can keep collecting thoughts and make a first version of Contribute guide

Pickra commented 6 years ago

Pull request templates - https://github.com/blog/2495-multiple-issue-and-pull-request-templates