Developers Handbook - intended scope & direction?
Forum rules
Be nice to others! Respect the FreeCAD code of conduct!
Be nice to others! Respect the FreeCAD code of conduct!
Re: Developers Handbook - intended scope & direction?
That failure message has been observed by all who run the command. The underlying failure has not been investigated yet, as the environment is successfully constructed.
Re: Developers Handbook - intended scope & direction?
I don't want to hijack your post but since we are talking about the Developers Handbook, maybe I can also add something to the Roadmap.
Right now the Roadmap is only a wish-list to me. It is not concrete. How can you make it concrete? By adding RFCs to it. How? Take a look at this:
This is not concrete, but if you make it look like this then it becomes concrete and also much more visible to anyone:
What is now this number at the end? It is a link to a RFC, in the first case it's RFC #515.
What is a RFC? A RFC is a Request For Comments. https://en.wikipedia.org/wiki/Request_for_Comments
In fact, a RFC is a github issue, just like a FreeCAD issue. In the programming language Nim they store the RFCs separate from the main github. https://github.com/nim-lang/RFCs Go to issues and you see the list of open RFCs and then you can also create a new issue, push the button and then you see the content of a new RFC.
What are the benefits of a RFC?
- You need to think very carefully when you create a RFC, so you are probably not making many mistakes.
- Anyone can see who is involved.
- It is a github issue.
- The discussion takes place at github, not here.
- This is linked to the Roadmap, so the RFC is visible.
- When it is done you can strike it out.
Right now the Roadmap is only a wish-list to me. It is not concrete. How can you make it concrete? By adding RFCs to it. How? Take a look at this:
Code: Select all
2. Modern UI concepts
1. Eg “pie menu”
2. Context menus
3. Ribbon Bar
Code: Select all
2. Modern UI concepts
1. Eg “pie menu” - #515
2. Context menus - #301
3. Ribbon Bar - #15
What is a RFC? A RFC is a Request For Comments. https://en.wikipedia.org/wiki/Request_for_Comments
In fact, a RFC is a github issue, just like a FreeCAD issue. In the programming language Nim they store the RFCs separate from the main github. https://github.com/nim-lang/RFCs Go to issues and you see the list of open RFCs and then you can also create a new issue, push the button and then you see the content of a new RFC.
What are the benefits of a RFC?
- You need to think very carefully when you create a RFC, so you are probably not making many mistakes.
- Anyone can see who is involved.
- It is a github issue.
- The discussion takes place at github, not here.
- This is linked to the Roadmap, so the RFC is visible.
- When it is done you can strike it out.
About Nim. Latest Release 2.0.2. Here is Nim in 100 seconds and a Nim package. There are Qt and OCCT packages.
Re: Developers Handbook - intended scope & direction?
I knew that I forgot something in my previous remark about RFCs, but I didn't know what. Now I know
You guys have already been working on the things that you want to do and you created issues as well, so I suggest to add the issue to the end of the line, like I said in my previous post. It doesn't need to be a RFC, but then still people know what is going on and I think that is important
FreeCAD already has a issue management system in github, but no RFC. I know a RFC is not that different from a issue, but a RFC is specifically about new functionality or a change of functionality, and the word RFC means something to a guy because when you see a list of RFCs you see a list of progress
A RFC is NOT a issue, it is only stored as a issue in github, and that is why I think that a RFC is better stored as a separate github repository. Think about https://github.com/FreeCAD/RFCs
And keep in mind that a RFC can be used in any document, but you need to link that document of course to the RFC and in the RFC you need to add a link to the document, vice versa.
That is all.
You guys have already been working on the things that you want to do and you created issues as well, so I suggest to add the issue to the end of the line, like I said in my previous post. It doesn't need to be a RFC, but then still people know what is going on and I think that is important
FreeCAD already has a issue management system in github, but no RFC. I know a RFC is not that different from a issue, but a RFC is specifically about new functionality or a change of functionality, and the word RFC means something to a guy because when you see a list of RFCs you see a list of progress
A RFC is NOT a issue, it is only stored as a issue in github, and that is why I think that a RFC is better stored as a separate github repository. Think about https://github.com/FreeCAD/RFCs
And keep in mind that a RFC can be used in any document, but you need to link that document of course to the RFC and in the RFC you need to add a link to the document, vice versa.
That is all.
About Nim. Latest Release 2.0.2. Here is Nim in 100 seconds and a Nim package. There are Qt and OCCT packages.
Re: Developers Handbook - intended scope & direction?
I have to say that for those of us who've worked in an ITIL environment, RFC stands for Request For Change
Re: Developers Handbook - intended scope & direction?
Yes, you are right. Sorry.
About Nim. Latest Release 2.0.2. Here is Nim in 100 seconds and a Nim package. There are Qt and OCCT packages.
Re: Developers Handbook - intended scope & direction?
But you like my idea?
About Nim. Latest Release 2.0.2. Here is Nim in 100 seconds and a Nim package. There are Qt and OCCT packages.
- sliptonic
- Veteran
- Posts: 3457
- Joined: Tue Oct 25, 2011 10:46 pm
- Location: Columbia, Missouri
- Contact:
Re: Developers Handbook - intended scope & direction?
I do.
Let's update the handbook. PRs welcome
- adrianinsaval
- Veteran
- Posts: 5541
- Joined: Thu Apr 05, 2018 5:15 pm
Re: Developers Handbook - intended scope & direction?
We've tried something like that before and it doesn't work: https://github.com/FreeCAD/FreeCAD-Enha ... -Proposals, IMO if we do that we are only worsening the problem by splitting things into even more places, instead we could direct those to github discussions on the main repo or just plain old issues.
Re: Developers Handbook - intended scope & direction?
Yes, i saw that one too. It is very empty... Well then just add the issue number.adrianinsaval wrote: ↑Wed May 17, 2023 10:24 pm We've tried something like that before and it doesn't work: https://github.com/FreeCAD/FreeCAD-Enha ... -Proposals, IMO if we do that we are only worsening the problem by splitting things into even more places, instead we could direct those to github discussions on the main repo or just plain old issues.
About Nim. Latest Release 2.0.2. Here is Nim in 100 seconds and a Nim package. There are Qt and OCCT packages.