Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[ Feature Request ] Adding CONTRIBUTING.md file #244

Closed
AbrahemAlhofe opened this issue Jun 25, 2021 · 3 comments
Closed

[ Feature Request ] Adding CONTRIBUTING.md file #244

AbrahemAlhofe opened this issue Jun 25, 2021 · 3 comments

Comments

@AbrahemAlhofe
Copy link
Contributor

I saw there is no CONTRIBUTING.md file in the repository and there are a lot of things that should be existing to make this code readable and maintainable and rid of some mysteries in a lot of parts.

Rules for the pull request process

Link your pull request with an issue

The issue will be a discussion for every new feature/bug to know what is the best way to implement it

Use ( Conventional Commits ) instead of ( "Da" or "upd" )

Besides the benefit from using readable commit messages, conventional commits will help us to generate CHANGELOG.md automatic

The Reasons behind every decision

Adding section to demonstrate why you used this tech ( ex. typescript instead of flow, less instead of sass ) so if the rules you put to choose this tech expired you can use another tech

Semantic issue title if you will suggest feature and will not work on it use [ Feature Suggestion ] else [ Feature Request ]

If you agree to these rules I can add a pull request and add this CONTRIBUTING.md guide
@quatrochan
Copy link
Collaborator

@AbrahemAlhofe It would be great to see good CONTRIBUTING.md added

@AbrahemAlhofe
Copy link
Contributor Author

I'm now working on the contribution guide but I want to know some info

first, what is the best way from your opinion to run the project and going into adding some features ( pull request )
second, why did you use less instead of scss or just using postcss
third, If there is a bug what do you want to know from the user about the bug to fix it

AbrahemAlhofe added a commit to AbrahemAlhofe/Equal that referenced this issue Jun 29, 2021
@AbrahemAlhofe
chore: add CONTRIBUTING.md file
e3ff3fc 
    - add "Feature Request" process steps
    - add "Bug Report" process steps
    - add "Contributing" process steps
    - add "Development" process steps

close Equal-UI#244
@quatrochan
Copy link
Collaborator

quatrochan commented Jun 29, 2021 •
edited

what is the best way from your opinion to run the project and going into adding some

npm i or yarn and run yarn dev for the page with small examples of mostly all components and real-time changes. But I prefer to cd docs && yarn && yarn dev for full docs and real-time code changes. The just push a pr with feature/ fix/ or other necessary prefix.

why did you use less instead of scss or just using postcss

It was good just for start. Right now PostCSS considered as a next step towards 1.0

If there is a bug what do you want to know from the user about the bug to fix it

Reproductions steps, browser & OS version. Maybe some issue specific info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@quatrochan @AbrahemAlhofe