-
Notifications
You must be signed in to change notification settings - Fork 44
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1118 from Finastra/feature/update_contribution_docs
update documentation
- Loading branch information
Showing
2 changed files
with
16 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,41 @@ | ||
# Contributing to Finastra Design System | ||
|
||
Want to file a bug, contribute some code, or improve documentation? Excellent! 🤗❤️ | ||
Here are some guidelines to make the most out of your help. | ||
Contribution to Finastra Design System is now based on a community support model. This means everybody's welcome to: | ||
- submit and discuss ideas and questions | ||
- deliver new features and bug fixes | ||
- review and comment on pull requests created by other community members | ||
The Finastra FFDC UX Services team will no longer develop features or fix bugs raised by other teams. However, we'll review and comment on newly committed code to ensure good practices and coding standards are in place. Therefore, if you're willing to contribute, please have a look at the below guidelines. | ||
|
||
- [Contributing to Finastra Design System](#contributing-to-finastra-design-system) | ||
- [ Asking Questions](#-asking-questions) | ||
- [ Issues and Bugs](#-issues-and-bugs) | ||
- [ Feature Requests](#-feature-requests) | ||
- [ Submission Guidelines](#-submission-guidelines) | ||
|
||
## <a name="questions"></a> Asking Questions | ||
|
||
At the moment we only have a Microsoft Teams' channel dedicated to questions. If you're not part of the organization, you can still send your questions by mail to [UXG - Questions]([email protected]). | ||
Should you have any questions or concerns, just submit a new GitHub [Discussion](https://github.com/Finastra/finastra-design-system/discussions) to allow the community to give their feedback. If you feel like answering others' questions, that's more than welcome! Please bear in mind that before submitting a new discussion, you should review the already answered topics to minimize duplicates. | ||
|
||
## <a name="issues"></a> Issues and Bugs | ||
|
||
If you discover a bug along your way, you can help by filling a Github issue. | ||
Before submitting it, please consider the following steps: | ||
If you discover a bug along your way, start by filing a GitHub Issue. This way you ensure transparency to other community members and make it easier to track the progress of the fix. Before submitting a bug, please consider the following steps: | ||
|
||
- Check you are using the latest version | ||
- Check you are using the latest version of the repository | ||
- Make sure the bug is not already covered in the list of open issues | ||
- Reproduce the issue in a live editor like [StackBlitz](https://stackblitz.com/) or [CodePen](https://codepen.io/) | ||
- Take screenshots if it's a UI issue | ||
- Provide the informations requested in the [bug report template](https://github.com/finastra/finastra-design-system/issues/new?template=bug_report.md) | ||
|
||
Then the process of reviewing, planning and hopefully fixing your issue will start. | ||
- Provide the information requested in the [bug report template](https://github.com/finastra/finastra-design-system/issues/new?template=bug_report.md) | ||
- Once you have the fix ready, create a PR so that the community members can provide their feedback | ||
|
||
## <a name="features"></a> Feature Requests | ||
|
||
You experienced frustation when trying to achieve some design using the theme? | ||
You identified some components that could help other developpers? | ||
Open a GitHub [feature request](https://github.com/finastra/finastra-design-system/issues/new?template=feature_request.md) | ||
|
||
You will be requested to fill a form, describing clearly and concisely your problem. We will discuss your suggestion to understand the need and optimize the solution. | ||
Have you encountered a feature gap in the Finastra Design System? Do you have ideas on how to make the components more functional and user friendly? | ||
Open a GitHub [feature request](https://github.com/finastra/finastra-design-system/issues/new?template=feature_request.md) for tracking purposes and follow Submission Guidelines below to enrich the repository with your code. | ||
|
||
## <a name="submit"></a> Submission Guidelines | ||
|
||
Before creating a new pull request please make sure there is no related ongoing work by searching the [GitHub issues](https://github.com/finastra/finastra-design-system/issues) and [Github PRs](https://github.com/finastra/finastra-design-system/pulls) as well. | ||
If you find something similar, join the discussion and consider contributing to it. | ||
If nothing match your search, then create a new issue accordingly ([Issues and Bugs](#issues), [Feature Requests](#features)). | ||
When your issue is validated and you are assigned to it, you can start with those simple steps: | ||
All code submissions require review, this is done through GitHub Pull Requests. Before creating a new pull request please make sure there is no related ongoing work by searching the [GitHub issues](https://github.com/finastra/finastra-design-system/issues) and [Github PRs](https://github.com/finastra/finastra-design-system/pulls) as well. If you find something similar, join the discussion and consider contributing to it. | ||
|
||
- Fork the repository by cliking the Fork button in the top right corner. | ||
- Fork the repository by clicking the Fork button in the top right corner. | ||
- Go to your repository and clone your fork | ||
|
||
```sh | ||
|
@@ -81,7 +75,7 @@ When your issue is validated and you are assigned to it, you can start with thos | |
> npm run stylelint | ||
``` | ||
|
||
- fix the presented errors / problems if any | ||
- fix the presented errors or problems if any | ||
- Commit your code, add a commit message following [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0-beta.4/) guidelines | ||
|
||
```sh | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters