Skip to content

Commit

Permalink
Docs: Refine the contribution guidelines.
Browse files Browse the repository at this point in the history
  • Loading branch information
filiphsps committed Dec 3, 2023
1 parent 8676279 commit f00b51b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ To keep the project running smoothly, we have a few guidelines that we ask contr

- [Questions, Feedback, or Support](#questions-feedback-or-support)
- [Language Policy](#language-policy)
- [Copyright](#copyright)

## Questions, Feedback, or Support

Expand All @@ -23,5 +24,11 @@ While we are a global community, we ask that all communications be kept in Engli

We recommend the use of spell-, grammar-checkers and other tooling to help you with this. Some browsers like `MSEdge` include powerful grammar and spell-checkers out of the box.

> [!NOTE]
## Copyright

When making a major contribution (e.g. adding a new feature or changing an existing one), please add your (or your employers) name to the bottom of the copyright holders in the `LICENSE` file. This is to ensure that you are properly credited for your work and get to retain the rights to your contributions.

---

> [!NOTE]
> These Contribution Guidelines are still a work in progress and as such a lot is still missing and everything that is already here is subject to change at any time without prior notice. Please bear with us as we work to improve them. Contributions are welcome and encouraged! 😄
6 changes: 3 additions & 3 deletions packages/core/nordstar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@

## 🚀 Getting Started

> [!NOTE]
> [!NOTE]
> Nordstar is still in early development and is **not** yet ready for production use. Beware of dragons ahead!
```bash
Expand All @@ -26,7 +26,7 @@ Visit [https://nordstar.nordcom.io/docs/](https://nordstar.nordcom.io/docs/?utm_

## 🏢 Real World Usage

• We here at Nordcom Group Inc. use Nordstar in for our applications and services, like on [Sweet Side of Sweden](https://www.sweetsideofsweden.com/?utm_source=nordstar&utm_campaign=oss) (soon) and [nordcom.io](https://nordcom.io/?utm_source=nordstar&utm_campaign=oss).
• We here at Nordcom Group Inc. use Nordstar in for our applications and services, like on [Nordcom Commerce](https://shops.nordcom.io/?utm_source=nordstar&utm_medium=github&utm_campaign=oss), [Sweet Side of Sweden](https://www.sweetsideofsweden.com/?utm_source=nordstar&utm_medium=github&utm_campaign=oss) (soon) and [nordcom.io](https://nordcom.io/?utm_source=nordstar&utm_medium=github&utm_campaign=oss).

> If you use Nordstar in one your or your company's project, please let us know! We'd love to feature you here and on Nordstar's website.
Expand All @@ -43,4 +43,4 @@ To get started, please read our [Contribution Guidelines](/CONTRIBUTING.md) as i

## 📝 License

Licensed under the [MIT License](/LICENSE). Created by **[Nordcom Group Inc.](https://nordcom.io/?utm_source=nordstar&utm_campaign=oss)** with the help of outside contributors.
Licensed under the [MIT License](/LICENSE). Created by **[Nordcom Group Inc.](https://nordcom.io/?utm_source=nordstar&utm_medium=github&utm_campaign=oss)** with the help of outside contributors.

1 comment on commit f00b51b

@vercel
Copy link

@vercel vercel bot commented on f00b51b Dec 3, 2023

Choose a reason for hiding this comment

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

Successfully deployed to the following URLs:

nordstar – ./docs

nordstar-git-master-nordcom.vercel.app
nordstar-nordcom.vercel.app
nordstar.vercel.app
nordstar.nordcom.io

Please sign in to comment.