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.

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

feat(monorepo): Add contributing guide #1588

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

michelguerin
Copy link

Details the installation steps to contribute as a developer.

  • Link from readme to contributing guide + refacto
  • Add .env.example file for needed environment variables
  • Add .env to .gitignore

* Link from readme to contributing guide + refacto
* Add .env.example file for needed environment variables
* Add `.env` to `.gitignore`
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@@ -7,13 +7,13 @@

Open Substation Communication Designer is an editor for SCL files as described in `IEC 61850-6`.

> Try it out at [openscd.github.io](https://openscd.github.io)!
> Try it out at [openscd.github.io](https://openscd.github.io)!
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thank you!

@trusz
Copy link
Member

trusz commented Nov 12, 2024

We already have a CONTRIBUTING.md in the core package: https://github.com/openscd/open-scd/blob/main/packages/core/CONTRIBUTING.md

Have you took that into consideration?

@michelguerin
Copy link
Author

We already have a CONTRIBUTING.md in the core package: https://github.com/openscd/open-scd/blob/main/packages/core/CONTRIBUTING.md

Have you took that into consideration?

Oups, didn't see this. I'll merge these to file in favor of the root one. I'll make a new proposition in the next commit.

@michelguerin
Copy link
Author

@trusz Update done : I removed the contributing guide from the core package and merge its content to root.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants