added RELEASE.md and CONTRIBUTING.md files #420
Conversation
mkopcins
force-pushed
the
@mkopcins/repo-upkeep
branch
from
de93392 to
f0a213e
Compare
mkopcins
force-pushed
the
@mkopcins/repo-upkeep
branch
from
b426521 to
1b91fc8
Compare
|
Two additions from my side to
And there is a typo in PR title: |
CONTRIBUTING.md
Outdated
| ## Feature request | ||
|
|
||
| Have an idea or is there a feature you would like to see added? Feel free to create a PR from a fork 😉. Alternatively if you don't have time for that just create a `🚀 Feature request` issue and fill in the necessary information. | ||
| The most important things to include are: | ||
|
|
||
| 1. What is the motivation behind it? Is it something that is missing but is present in another library? Or maybe you need something more specific for your use case? Or just an idea that popped into your head? | ||
| We'd love to hear about this! | ||
|
|
||
| 2. Describe it - add as much detail as you can. This helps to avoid any miscommunication problems and helps us to better understand it. | ||
|
|
||
| 3. Provide a code snippet with the example usage (optional). | ||
|
|
||
| 4. If there is a similar feature somewhere else drop a link (optional). | ||
|
|
There was a problem hiding this comment.
Maybe we should also mention here that it is not restricted to features but also new model support to kind of let people know that we'd like to see what they need in terms of model coverage, but feel free to ignore though
There was a problem hiding this comment.
I thought this is somewhat contained in the ways-to-contribute/Export-new-models-to-ET-format section, but I can write it here explicitely
CONTRIBUTING.md
Outdated
| If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions too). | ||
|
|
There was a problem hiding this comment.
remember to add changes to previous docs versions too). I'm not sure if this will be understandable for someone who doesn't know this codebase
There was a problem hiding this comment.
We may change it to
| If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions too). | |
| If you found some inconsistencies in our documentation or just something is missing just open a PR with suggested changes (remember to add changes to previous docs versions, in `versioned_docs` directory, too). | |
RELEASE.md
Outdated
| 4. Commit with a message 'Release v{MAJOR}.{MINOR}.0'. (We want to keep the latest `MINOR` version on the `main` branch.) | ||
| 5. Create a new branch release branch `release/{MAJOR}.{MINOR}`and push it to the remote. | ||
| 6. Stability tests are performed on the release branch and all fixes to the new-found issues are pushed into the main branch and cherry-picked into the release branch. This allows for further development on the main branch without interfering with the release process. | ||
| 7. Once all tests are passed, tag the release branch with proper version tag `v{MAJOR}.{MINOR}.0` and run `npm publish`. |
There was a problem hiding this comment.
I think this is confusing, what tests are you referring to?
There was a problem hiding this comment.
Since we don't have any automated tests right now and the only testing we do is test apps before release that's what I mean. In the future we should for sure add testing to the pipeline, at least for releases and maybe in the PRs. Also this is only for our internal use really
mkopcins
changed the title
Description
Add RELEASE.md na CONTRIBUTING.md files.
Type of change
Tested on
Testing instructions
Screenshots
Related issues
Checklist
Additional notes